AsymmetricKey AsymmetricKey AsymmetricKey Class

Definition

The AsymmetricKey object represents a SQL Server asymmetric key.

public ref class AsymmetricKey sealed : Microsoft::SqlServer::Management::Smo::NamedSmoObject, Microsoft::SqlServer::Management::Common::IAlterable, Microsoft::SqlServer::Management::Common::IDroppable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcSupportsDesignMode, Microsoft::SqlServer::Management::Smo::IObjectPermission
[Microsoft.SqlServer.Management.Facets.EvaluationMode(Microsoft.SqlServer.Management.Dmf.AutomatedPolicyEvaluationMode.Enforce | Microsoft.SqlServer.Management.Dmf.AutomatedPolicyEvaluationMode.CheckOnChanges | Microsoft.SqlServer.Management.Dmf.AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[Microsoft.SqlServer.Management.Facets.StateChangeEvent("ALTER_ASYMMETRIC_KEY", "ASYMMETRICKEY", "ASYMMETRIC KEY")]
[Microsoft.SqlServer.Management.Facets.StateChangeEvent("ALTER_AUTHORIZATION_DATABASE", "ASYMMETRIC KEY")]
[Microsoft.SqlServer.Management.Facets.StateChangeEvent("CREATE_ASYMMETRIC_KEY", "ASYMMETRICKEY", "ASYMMETRIC KEY")]
[Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElement(Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementFlags.Standalone | Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementFlags.SqlAzureDatabase)]
[Microsoft.SqlServer.Management.Sdk.Sfc.PhysicalFacet]
public sealed class AsymmetricKey : Microsoft.SqlServer.Management.Smo.NamedSmoObject, Microsoft.SqlServer.Management.Common.IAlterable, Microsoft.SqlServer.Management.Common.IDroppable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcSupportsDesignMode, Microsoft.SqlServer.Management.Smo.IObjectPermission
Public NotInheritable Class AsymmetricKey
Inherits NamedSmoObject
Implements IAlterable, IDroppable, IObjectPermission, ISfcSupportsDesignMode
Inheritance
Attributes
Microsoft.SqlServer.Management.Facets.EvaluationModeAttribute Microsoft.SqlServer.Management.Facets.StateChangeEventAttribute Microsoft.SqlServer.Management.Facets.StateChangeEventAttribute Microsoft.SqlServer.Management.Facets.StateChangeEventAttribute Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementAttribute PhysicalFacetAttribute
Implements
Microsoft.SqlServer.Management.Common.IAlterableMicrosoft.SqlServer.Management.Common.IAlterableMicrosoft.SqlServer.Management.Common.IAlterable Microsoft.SqlServer.Management.Common.IDroppableMicrosoft.SqlServer.Management.Common.IDroppableMicrosoft.SqlServer.Management.Common.IDroppable ISfcSupportsDesignModeISfcSupportsDesignModeISfcSupportsDesignMode IObjectPermissionIObjectPermissionIObjectPermission

Examples

Granting, Revoking, and Denying Permissions

Remarks

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

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

To create an AsymmetricKey object, users must have CREATE ASYMMETRIC KEY role permission on the parent database.

To drop an AsymmetricKey object, users must be the owner of the asymmetric key or have CONTROL permission on the asymmetric key.

To grant, deny, and revoke permission on the AsymmetricKey object, users must have CONROL permission on the asymmetric key.

Constructors

AsymmetricKey() AsymmetricKey() AsymmetricKey()

Initializes a new instance of the AsymmetricKey class.

AsymmetricKey(Database, String) AsymmetricKey(Database, String) AsymmetricKey(Database, String)

Initializes a new instance of the AsymmetricKey class on the specified database.

Properties

ExecuteForScalar ExecuteForScalar ExecuteForScalar

Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option.

(Inherited from SqlSmoObject)
ExecutionManager ExecutionManager ExecutionManager

Gets the object to execute to the manager.

(Inherited from SqlSmoObject)
ID ID ID

Gets the ID value that uniquely identifies the asymmetric key.

IsTouched IsTouched IsTouched

Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server.

(Inherited from SqlSmoObject)
KeyEncryptionAlgorithm KeyEncryptionAlgorithm KeyEncryptionAlgorithm

Gets the encryption algorithm used to encrypt the asymmetric key.

KeyLength KeyLength KeyLength

Gets the length of the asymmetric key.

Name Name Name

Gets or sets the name of the object.

(Inherited from NamedSmoObject)
ObjectInSpace ObjectInSpace ObjectInSpace

Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server.

(Inherited from SqlSmoObject)
Owner Owner Owner

Gets or sets the name of the database principal that is the owner of the asymmetric key.

Parent Parent Parent

Gets the Database object that is the parent of the AsymmetricKey object.

PrivateKeyEncryptionType PrivateKeyEncryptionType PrivateKeyEncryptionType

Gets the encryption type for the private key for the asymmetric key.

Properties Properties Properties

Gets a collection of Property objects that represent the object properties.

(Inherited from SqlSmoObject)
ProviderName ProviderName ProviderName

Gets or sets an asymmetric security key provider name.

PublicKey PublicKey PublicKey

Gets the public key for the asymmetric key.

ScalarResult ScalarResult ScalarResult

Gets the scalar result for the referenced object.

(Inherited from SqlSmoObject)
Sid Sid Sid

Gets the logon security identifier (SID) for the asymmetric key.

State State State

Gets the state of the referenced object.

(Inherited from SmoObjectBase)
Thumbprint Thumbprint Thumbprint

Gets the globally unique SHA-1 hash thumbprint for the asymmetric key.

Urn Urn Urn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.

(Inherited from SqlSmoObject)
UserData UserData UserData

Gets or sets user-defined data associated with the referenced object.

(Inherited from SmoObjectBase)

Methods

AddDatabaseContext(StringCollection) AddDatabaseContext(StringCollection) AddDatabaseContext(StringCollection)

Add the database context to the collection of queries identified by the queries parameter.

(Inherited from SqlSmoObject)
AddPrivateKey(String) AddPrivateKey(String) AddPrivateKey(String)

Adds a private key to the asymmetric key with the specified password.

Alter() Alter() Alter()

Updates any AsymmetricKey object property changes on the instance of SQL Server.

AlterImpl() AlterImpl() AlterImpl()

Activates the object altered event.

(Inherited from SqlSmoObject)
AlterImplWorker() AlterImplWorker() AlterImplWorker()

Calls the Alter methods.

(Inherited from SqlSmoObject)
BindDefaultImpl(String, String, Boolean) BindDefaultImpl(String, String, Boolean) BindDefaultImpl(String, String, Boolean)

Binds the default items identified by the parameters.

(Inherited from SqlSmoObject)
BindRuleImpl(String, String, Boolean) BindRuleImpl(String, String, Boolean) BindRuleImpl(String, String, Boolean)

Binds the rule schema to the rule and columns identified by the parameters.

(Inherited from SqlSmoObject)
ChangePrivateKeyPassword(String, String) ChangePrivateKeyPassword(String, String) ChangePrivateKeyPassword(String, String)

Modifies the private key password that is used to secure the private key for the asymmetric key.

CheckObjectState() CheckObjectState() CheckObjectState()

Validates the state of the referenced object.

(Inherited from SqlSmoObject)
CheckObjectState(Boolean) CheckObjectState(Boolean) CheckObjectState(Boolean)

Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created.

(Inherited from SqlSmoObject)
CheckObjectStateImpl(Boolean) CheckObjectStateImpl(Boolean) CheckObjectStateImpl(Boolean)

Checks the state of a SqlSmoObject.

(Inherited from SqlSmoObject)
CleanObject() CleanObject() CleanObject()

Sets the object to its unmodified state.

(Inherited from SqlSmoObject)
Create(AsymmetricKeyEncryptionAlgorithm) Create(AsymmetricKeyEncryptionAlgorithm) Create(AsymmetricKeyEncryptionAlgorithm)

Creates an asymmetric key on the instance of SQL Server with the specified encryption algorithm.

Create(AsymmetricKeyEncryptionAlgorithm, String) Create(AsymmetricKeyEncryptionAlgorithm, String) Create(AsymmetricKeyEncryptionAlgorithm, String)

Creates an asymmetric key on the instance of SQL Server with the specified encryption algorithm and the specified password.

Create(String, AsymmetricKeySourceType) Create(String, AsymmetricKeySourceType) Create(String, AsymmetricKeySourceType)

Creates an asymmetric key on the instance of SQL Server by loading the asymmetric key from the specified source.

Create(String, AsymmetricKeySourceType, String) Create(String, AsymmetricKeySourceType, String) Create(String, AsymmetricKeySourceType, String)

Creates an asymmetric key on the instance of SQL Server by loading the specified asymmetric key and by using the specified password.

Create(String, String, CreateDispositionType, AsymmetricKeySourceType) Create(String, String, CreateDispositionType, AsymmetricKeySourceType) Create(String, String, CreateDispositionType, AsymmetricKeySourceType)

Creates an asymmetric key on the instance of SQL Server by loading the specified asymmetric key and by using the specified password.

CreateImpl() CreateImpl() CreateImpl()

Creates an object with scripting options.

(Inherited from SqlSmoObject)
Deny(ObjectPermissionSet, String) Deny(ObjectPermissionSet, String) Deny(ObjectPermissionSet, String)

Denies the specified set of permissions for the specified grantee on the asymmetric key.

Deny(ObjectPermissionSet, String, Boolean) Deny(ObjectPermissionSet, String, Boolean) Deny(ObjectPermissionSet, String, Boolean)

Denies the specified set of permissions for the specified grantee and other users that the grantee granted the specified set of permissions on the asymmetric key.

Deny(ObjectPermissionSet, String[]) Deny(ObjectPermissionSet, String[]) Deny(ObjectPermissionSet, String[])

Denies the specified set of permissions for the specified grantees on the asymmetric key.

Deny(ObjectPermissionSet, String[], Boolean) Deny(ObjectPermissionSet, String[], Boolean) Deny(ObjectPermissionSet, String[], Boolean)

Denies the specified set of permissions for the specified grantees and other users that the grantee granted the specified set of permissions on the asymmetric key.

Discover() Discover() Discover()

Discovers a list of type Object.

(Inherited from SqlSmoObject)
Drop() Drop() Drop()

Removes the asymmetric key from the instance of SQL Server.

Drop(Boolean) Drop(Boolean) Drop(Boolean)

Removes an Extensible Key Management (EKM) key from an EKM device.

DropImpl(Boolean) DropImpl(Boolean) DropImpl(Boolean)

Drops a SqlSmoObject.

(Inherited from SqlSmoObject)
DropImplWorker(Urn, Boolean) DropImplWorker(Urn, Boolean) DropImplWorker(Urn, Boolean)

Drops the IMPL worker.

(Inherited from SqlSmoObject)
EnumObjectPermissions() EnumObjectPermissions() EnumObjectPermissions()

Enumerates a list of object permissions for the asymmetric key.

EnumObjectPermissions(ObjectPermissionSet) EnumObjectPermissions(ObjectPermissionSet) EnumObjectPermissions(ObjectPermissionSet)

Enumerates a list of object permissions for a specified permission on the asymmetric key.

EnumObjectPermissions(String) EnumObjectPermissions(String) EnumObjectPermissions(String)

Enumerates a list of object permissions for a specified grantee on the asymmetric key.

EnumObjectPermissions(String, ObjectPermissionSet) EnumObjectPermissions(String, ObjectPermissionSet) EnumObjectPermissions(String, ObjectPermissionSet)

Enumerates a list of object permissions for a specified grantee and a specified permission on the asymmetric key.

ExecuteNonQuery(StringCollection, Boolean) ExecuteNonQuery(StringCollection, Boolean) ExecuteNonQuery(StringCollection, Boolean)

Executes a batch of statements that does not return a result set.

(Inherited from SqlSmoObject)
ExecuteRenameQuery(String) ExecuteRenameQuery(String) ExecuteRenameQuery(String)

Executes the rename query for the object.

(Inherited from NamedSmoObject)
FormatSqlVariant(Object) FormatSqlVariant(Object) FormatSqlVariant(Object)

Formats an object as Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.

(Inherited from SqlSmoObject)
GenerateAlterEvent() GenerateAlterEvent() GenerateAlterEvent()

Generates the alter event with the specified value.

(Inherited from SqlSmoObject)
GenerateAlterEvent(Urn, Object) GenerateAlterEvent(Urn, Object) GenerateAlterEvent(Urn, Object)

Generates alter event with the specified URN and inner object value.

(Inherited from SqlSmoObject)
GetContextDB() GetContextDB() GetContextDB()

Gets the context database that is associated with this object.

(Inherited from SqlSmoObject)
GetDBName() GetDBName() GetDBName()

Gets the database name that is associated with the object.

(Inherited from SqlSmoObject)
GetFragOptionString(FragmentationOption) GetFragOptionString(FragmentationOption) GetFragOptionString(FragmentationOption)

Gets a FragmentationOption object as a string value.

(Inherited from SqlSmoObject)
GetPropValue(String) GetPropValue(String) GetPropValue(String)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetPropValueOptional(String) GetPropValueOptional(String) GetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetPropValueOptionalAllowNull(String) GetPropValueOptionalAllowNull(String) GetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetRealValue(Property, Object) GetRealValue(Property, Object) GetRealValue(Property, Object)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetServerName() GetServerName() GetServerName()

Gets the name of the instance of SQL Server with which the object is associated.

(Inherited from SqlSmoObject)
GetServerObject() GetServerObject() GetServerObject()

Gets the server of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetSqlServerVersionName() GetSqlServerVersionName() GetSqlServerVersionName()

Gets the version name of the instance of SQL Server with which the object is associated.

(Inherited from SqlSmoObject)
GetUrnRecursive(StringBuilder) GetUrnRecursive(StringBuilder) GetUrnRecursive(StringBuilder)

Assigns an Urn object of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetUrnRecursive(StringBuilder, UrnIdOption) GetUrnRecursive(StringBuilder, UrnIdOption) GetUrnRecursive(StringBuilder, UrnIdOption)

Assigns an Urn object of the SqlSmoObject object.

(Inherited from SqlSmoObject)
Grant(ObjectPermissionSet, String) Grant(ObjectPermissionSet, String) Grant(ObjectPermissionSet, String)

Grants the specified set of permissions to a grantee on the asymmetric key.

Grant(ObjectPermissionSet, String, Boolean) Grant(ObjectPermissionSet, String, Boolean) Grant(ObjectPermissionSet, String, Boolean)

Grants access to the specified permission to the grantee and the ability to grant access to other users on the asymmetric key.

Grant(ObjectPermissionSet, String, Boolean, String) Grant(ObjectPermissionSet, String, Boolean, String) Grant(ObjectPermissionSet, String, Boolean, String)

Grants the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the asymmetric key under an assumed role.

Grant(ObjectPermissionSet, String[]) Grant(ObjectPermissionSet, String[]) Grant(ObjectPermissionSet, String[])

Grants the specified set of permissions to the specified grantees on the asymmetric key.

Grant(ObjectPermissionSet, String[], Boolean) Grant(ObjectPermissionSet, String[], Boolean) Grant(ObjectPermissionSet, String[], Boolean)

Grants access to the specified permission to the grantees and the ability to grant access to other users on the asymmetric key.

Grant(ObjectPermissionSet, String[], Boolean, String) Grant(ObjectPermissionSet, String[], Boolean, String) Grant(ObjectPermissionSet, String[], Boolean, String)

Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the asymmetric key under an assumed role.

ImplInitialize(String[], OrderBy[]) ImplInitialize(String[], OrderBy[]) ImplInitialize(String[], OrderBy[])

Initializes the fields of the SqlSmoObject object.

(Inherited from SqlSmoObject)
Initialize() Initialize() Initialize()

Initializes the object and forces the properties be loaded.

(Inherited from SqlSmoObject)
Initialize(Boolean) Initialize(Boolean) Initialize(Boolean)

Initializes the object and forces the properties be loaded.

(Inherited from SqlSmoObject)
IsObjectDirty() IsObjectDirty() IsObjectDirty()

Verifies whether the object properties have been modified and the changes have not yet been persisted on the instance of SQL Server.

(Inherited from SqlSmoObject)
IsObjectInitialized() IsObjectInitialized() IsObjectInitialized()

Verifies whether the object has been initialized.

(Inherited from SqlSmoObject)
IsObjectInSpace() IsObjectInSpace() IsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.

(Inherited from SqlSmoObject)
IsSupportedProperty(String) IsSupportedProperty(String) IsSupportedProperty(String)

Determines whether the specified property is supported in the target .NET Framework.

(Inherited from SqlSmoObject)
IsVersion80SP3() IsVersion80SP3() IsVersion80SP3()

Determines whether the version of SQL Server is SQL Server 2000 with SP3.

(Inherited from SqlSmoObject)
IsVersion90AndAbove() IsVersion90AndAbove() IsVersion90AndAbove()

Determines whether the version of SQL Server is SQL Server 2005 or later.

(Inherited from SqlSmoObject)
MarkDropped() MarkDropped() MarkDropped()

Sets the SqlSmoState to dropped.

(Inherited from SqlSmoObject)
MarkForDropImpl(Boolean) MarkForDropImpl(Boolean) MarkForDropImpl(Boolean)

Sets the SqlSmoState for drop operation.

(Inherited from SqlSmoObject)
PostAlter() PostAlter() PostAlter()

The method that is activated after the SqlSmoObject is altered.

(Inherited from SqlSmoObject)
PostCreate() PostCreate() PostCreate()

The method that is activated after the SqlSmoObject is created.

(Inherited from SqlSmoObject)
PostDrop() PostDrop() PostDrop()

The method that is activated after the SqlSmoObject is dropped.

(Inherited from SqlSmoObject)
Refresh() Refresh() Refresh()

Refreshes the object and retrieves properties when the object is next accessed.

(Inherited from SqlSmoObject)
RemovePrivateKey() RemovePrivateKey() RemovePrivateKey()

Removes the private key from the asymmetric key.

RenameImpl(String) RenameImpl(String) RenameImpl(String)

This method supports the SMO infrastructure and is not intended to be used directly from your code.

(Inherited from NamedSmoObject)
RenameImplWorker(String) RenameImplWorker(String) RenameImplWorker(String)

Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

(Inherited from NamedSmoObject)
Revoke(ObjectPermissionSet, String) Revoke(ObjectPermissionSet, String) Revoke(ObjectPermissionSet, String)

Revokes a previously granted set of permissions for a grantee on the asymmetric key.

Revoke(ObjectPermissionSet, String, Boolean, Boolean) Revoke(ObjectPermissionSet, String, Boolean, Boolean) Revoke(ObjectPermissionSet, String, Boolean, Boolean)

Revokes previously granted permissions for a grantee on the asymmetric key 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.

Revoke(ObjectPermissionSet, String, Boolean, Boolean, String) Revoke(ObjectPermissionSet, String, Boolean, Boolean, String) Revoke(ObjectPermissionSet, String, Boolean, Boolean, String)

Revokes previously granted permissions for a grantee on the asymmetric key 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.

Revoke(ObjectPermissionSet, String[]) Revoke(ObjectPermissionSet, String[]) Revoke(ObjectPermissionSet, String[])

Revokes a previously granted set of permissions for a list of grantees on the asymmetric key.

Revoke(ObjectPermissionSet, String[], Boolean, Boolean) Revoke(ObjectPermissionSet, String[], Boolean, Boolean) Revoke(ObjectPermissionSet, String[], Boolean, Boolean)

Revokes previously granted permissions for grantees on the asymmetric key 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.

Revoke(ObjectPermissionSet, String[], Boolean, Boolean, String) Revoke(ObjectPermissionSet, String[], Boolean, Boolean, String) Revoke(ObjectPermissionSet, String[], Boolean, Boolean, String)

Revokes previously granted permissions for grantees on the asymmetric key 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.

ScriptImpl() ScriptImpl() ScriptImpl()

Gets a collection of scripts of the SqlSmoObject.

(Inherited from SqlSmoObject)
ScriptImpl(ScriptingOptions) ScriptImpl(ScriptingOptions) ScriptImpl(ScriptingOptions)

Gets a collection of scripts of the SqlSmoObject.

(Inherited from SqlSmoObject)
SetParentImpl(SqlSmoObject) SetParentImpl(SqlSmoObject) SetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.

(Inherited from SqlSmoObject)
SetSchemaOwned() SetSchemaOwned() SetSchemaOwned()

Sets the schema owned value for the named Smo object.

(Inherited from NamedSmoObject)
ThrowIfAboveVersion100(String) ThrowIfAboveVersion100(String) ThrowIfAboveVersion100(String)

Throws the object if above version 100.

(Inherited from SqlSmoObject)
ThrowIfAboveVersion80(String) ThrowIfAboveVersion80(String) ThrowIfAboveVersion80(String)

Throws SqlSmoObject if version is above 80.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion100(String) ThrowIfBelowVersion100(String) ThrowIfBelowVersion100(String)

Throws exception if the version is below 100.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion110(String) ThrowIfBelowVersion110(String) ThrowIfBelowVersion110(String)

Throws the object if the version belows 110.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion110Prop(String) ThrowIfBelowVersion110Prop(String) ThrowIfBelowVersion110Prop(String)

Throws the SqlSmoObject if version is below 110Prop.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion120(String) ThrowIfBelowVersion120(String) ThrowIfBelowVersion120(String)

Throws the object if the version is below 120.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion120Prop(String) ThrowIfBelowVersion120Prop(String) ThrowIfBelowVersion120Prop(String)

Throws the object if the version belows 120 property.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion130(String) ThrowIfBelowVersion130(String) ThrowIfBelowVersion130(String)

Throws the object if the version is below 130.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion130Prop(String) ThrowIfBelowVersion130Prop(String) ThrowIfBelowVersion130Prop(String)

Throws an object if BelowVersion130Prop.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion80(String) ThrowIfBelowVersion80(String) ThrowIfBelowVersion80(String)

Throws the object if the version is below 80.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion80SP3() ThrowIfBelowVersion80SP3() ThrowIfBelowVersion80SP3()

Throws an exception if the version is below 80SP3.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion90(String) ThrowIfBelowVersion90(String) ThrowIfBelowVersion90(String)

Throws the object if the version is below 90.

(Inherited from SqlSmoObject)
ToString() ToString() ToString()

Returns a String that represents the referenced object.

(Inherited from SqlSmoObject)
TouchImpl() TouchImpl() TouchImpl()

Implements a touch object.

(Inherited from SqlSmoObject)
UnbindDefaultImpl(Boolean) UnbindDefaultImpl(Boolean) UnbindDefaultImpl(Boolean)

Unbinds the default columns of the SqlSmoObject.

(Inherited from SqlSmoObject)
UnbindRuleImpl(Boolean) UnbindRuleImpl(Boolean) UnbindRuleImpl(Boolean)

Unbinds rules of the SqlSmoObject.

(Inherited from SqlSmoObject)
Validate(String, Object[]) Validate(String, Object[]) Validate(String, Object[])

Validates the state of an object.

(Inherited from SmoObjectBase)

Explicit Interface Implementations

IAlienObject.Discover() IAlienObject.Discover() IAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SqlSmoObject)
IAlienObject.GetDomainRoot() IAlienObject.GetDomainRoot() IAlienObject.GetDomainRoot()

Returns the root of the domain.

(Inherited from SqlSmoObject)
IAlienObject.GetParent() IAlienObject.GetParent() 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)
IAlienObject.GetPropertyType(String) IAlienObject.GetPropertyType(String) IAlienObject.GetPropertyType(String)

Gets the type of the specified property.

(Inherited from SqlSmoObject)
IAlienObject.GetPropertyValue(String, Type) IAlienObject.GetPropertyValue(String, Type) IAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.

(Inherited from SqlSmoObject)
IAlienObject.GetUrn() IAlienObject.GetUrn() 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)
IAlienObject.Resolve(String) IAlienObject.Resolve(String) IAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.

(Inherited from SqlSmoObject)
IAlienObject.SetObjectState(SfcObjectState) IAlienObject.SetObjectState(SfcObjectState) IAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.

(Inherited from SqlSmoObject)
IAlienObject.SetPropertyValue(String, Type, Object) IAlienObject.SetPropertyValue(String, Type, Object) IAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.

(Inherited from SqlSmoObject)
ISfcPropertyProvider.GetPropertySet() ISfcPropertyProvider.GetPropertySet() ISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SqlSmoObject)
ISfcSupportsDesignMode.IsDesignMode ISfcSupportsDesignMode.IsDesignMode ISfcSupportsDesignMode.IsDesignMode

Gets a value that indicates whether the object supports design mode.

Fields

m_ExtendedProperties m_ExtendedProperties m_ExtendedProperties

Represents a property that is defined to extend the properties provided by a SqlSmoObject.

(Inherited from SqlSmoObject)
singletonParent singletonParent singletonParent

Represents the singleton parent.

(Inherited from SqlSmoObject)

Events

PropertyChanged PropertyChanged PropertyChanged

Represents the event that occurs when a property is changed.

(Inherited from SqlSmoObject)
PropertyMetadataChanged PropertyMetadataChanged PropertyMetadataChanged

Represents the event that occurs when property metadata changes.

(Inherited from SqlSmoObject)

Applies to