EnvironmentInfo EnvironmentInfo EnvironmentInfo Class

Definition

Represents the information for an environment.

public ref class EnvironmentInfo sealed : Microsoft::SqlServer::Management::Sdk::Sfc::SfcInstance, Microsoft::SqlServer::Management::Common::IAlterable, Microsoft::SqlServer::Management::Common::ICreatable, Microsoft::SqlServer::Management::Common::IDroppable, Microsoft::SqlServer::Management::Common::IRenamable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcAlterable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcCreatable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcDroppable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcMovable, Microsoft::SqlServer::Management::Sdk::Sfc::ISfcRenamable
[Microsoft.SqlServer.Management.Sdk.Sfc.LocalizedPropertyResources("Microsoft.SqlServer.Management.IntegrationServices.LocalizableResources")]
[System.ComponentModel.TypeConverter(typeof(Microsoft.SqlServer.Management.Sdk.Sfc.LocalizableTypeConverter))]
public sealed class EnvironmentInfo : Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance, Microsoft.SqlServer.Management.Common.IAlterable, Microsoft.SqlServer.Management.Common.ICreatable, Microsoft.SqlServer.Management.Common.IDroppable, Microsoft.SqlServer.Management.Common.IRenamable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcAlterable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcCreatable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcDroppable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcMovable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcRenamable
Public NotInheritable Class EnvironmentInfo
Inherits SfcInstance
Implements IAlterable, ICreatable, IDroppable, IRenamable, ISfcAlterable, ISfcCreatable, ISfcDroppable, ISfcMovable, ISfcRenamable
Inheritance
EnvironmentInfoEnvironmentInfoEnvironmentInfo
Attributes
Implements
Microsoft.SqlServer.Management.Common.IAlterableMicrosoft.SqlServer.Management.Common.IAlterableMicrosoft.SqlServer.Management.Common.IAlterable Microsoft.SqlServer.Management.Common.ICreatableMicrosoft.SqlServer.Management.Common.ICreatableMicrosoft.SqlServer.Management.Common.ICreatable Microsoft.SqlServer.Management.Common.IDroppableMicrosoft.SqlServer.Management.Common.IDroppableMicrosoft.SqlServer.Management.Common.IDroppable Microsoft.SqlServer.Management.Common.IRenamableMicrosoft.SqlServer.Management.Common.IRenamableMicrosoft.SqlServer.Management.Common.IRenamable ISfcAlterableISfcAlterableISfcAlterable ISfcCreatableISfcCreatableISfcCreatable ISfcDroppableISfcDroppableISfcDroppable ISfcMovableISfcMovableISfcMovable ISfcRenamableISfcRenamableISfcRenamable

Constructors

EnvironmentInfo(CatalogFolder, String, String) EnvironmentInfo(CatalogFolder, String, String) EnvironmentInfo(CatalogFolder, String, String)

Initializes a new instance of the EnvironmentInfo class with the specified parent, name and description.

Properties

AbstractIdentityKey AbstractIdentityKey AbstractIdentityKey

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

(Inherited from SfcInstance)
Description Description Description

Gets or sets the description of the environment.

EnvironmentId EnvironmentId EnvironmentId

Gets the identifier of the environment.

IdentityKey IdentityKey IdentityKey

Gets the identity key.

Metadata Metadata Metadata

Returns metadata about the instance and its domain.

(Inherited from SfcInstance)
Name Name Name

Gets or sets the name of the environment.

Parent Parent Parent

Gets or sets the parent.

Properties Properties Properties

Returns a collection instance properties.

(Inherited from SfcInstance)
PropertyStorageProvider PropertyStorageProvider PropertyStorageProvider

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

(Inherited from SfcInstance)
State State State

Returns the state of the SfcInstance object.

(Inherited from SfcInstance)
Urn Urn Urn

Returns the uniform resource name of the SfcInstance object.

(Inherited from SfcInstance)
Variables Variables Variables

Gets the variables in the environment.

Methods

Alter() Alter() Alter()

Alters the environment in the back-end server.

AlterImpl() AlterImpl() AlterImpl()

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

(Inherited from SfcInstance)
CheckObjectCreated() CheckObjectCreated() CheckObjectCreated()

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

(Inherited from SfcInstance)
CheckObjectState() CheckObjectState() CheckObjectState()

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

(Inherited from SfcInstance)
Create() Create() Create()

Creates the EnvironmentInfo object in the back-end server.

CreateIdentityKey() CreateIdentityKey() CreateIdentityKey()

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

(Inherited from SfcInstance)
CreateImpl() CreateImpl() CreateImpl()

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

(Inherited from SfcInstance)
Deny(PermissionType, String) Deny(PermissionType, String) Deny(PermissionType, String)

Denies the permission to a specified user.

Discover(ISfcDependencyDiscoveryObjectSink) Discover(ISfcDependencyDiscoveryObjectSink) Discover(ISfcDependencyDiscoveryObjectSink)

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

(Inherited from SfcInstance)
Drop() Drop() Drop()

Removes the EnvironmentInfo object in the back-end server.

DropImpl() DropImpl() DropImpl()

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

(Inherited from SfcInstance)
GetChildCollection(String) GetChildCollection(String) GetChildCollection(String)

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

(Inherited from SfcInstance)
GetDomain() GetDomain() GetDomain()

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

(Inherited from SfcInstance)
GetEffectivePermissions() GetEffectivePermissions() GetEffectivePermissions()

Retrieves the effective permissions of the EnvironmentInfo object.

GetExplicitPermissions() GetExplicitPermissions() GetExplicitPermissions()

Retrieves the explicit permissions of the EnvironmentInfo object.

GetExplicitPermissions(String) GetExplicitPermissions(String) GetExplicitPermissions(String)

Retrieves the explicit permissions of the EnvironmentInfo object for a specified user.

GetObjectFactory() GetObjectFactory() GetObjectFactory()

Retrieves the factory to create a new instance.

GetPropertySet() GetPropertySet() GetPropertySet()

Returns the set of properties for the SfcInstance object.

(Inherited from SfcInstance)
GetTypeMetadataImpl() GetTypeMetadataImpl() GetTypeMetadataImpl()

Indicates the domains that override by returning the right TypeMetadata class directly. Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
Grant(PermissionType, String) Grant(PermissionType, String) Grant(PermissionType, String)

Grants the permission to a specified user.

InitializeUIPropertyState() InitializeUIPropertyState() InitializeUIPropertyState()

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

(Inherited from SfcInstance)
MarkForDropImpl(Boolean) MarkForDropImpl(Boolean) MarkForDropImpl(Boolean)

Returns a value that indicates the existing objects to be dropped. Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
MarkRootAsConnected() MarkRootAsConnected() MarkRootAsConnected()

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

(Inherited from SfcInstance)
Move(String) Move(String) Move(String)

Moves the EnvironmentInfo object to be a child of another folder.

MoveImpl(SfcInstance) MoveImpl(SfcInstance) MoveImpl(SfcInstance)

Indicates the new parent object to move in an instance. Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs) OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs) OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs)

Invoked whenever the effective value of any SfcInstance metadata is updated.

(Inherited from SfcInstance)
OnPropertyValueChanges(PropertyChangedEventArgs) OnPropertyValueChanges(PropertyChangedEventArgs) OnPropertyValueChanges(PropertyChangedEventArgs)

Invoked whenever the effective value of any SfcInstance property is updated.

(Inherited from SfcInstance)
PostAlter(Object) PostAlter(Object) PostAlter(Object)

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

(Inherited from SfcInstance)
PostCreate(Object) PostCreate(Object) PostCreate(Object)

Indicates the default implementor that creates the execution result. Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)
PostDrop(Object) PostDrop(Object) PostDrop(Object)

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

(Inherited from SfcInstance)
PostMove(Object) PostMove(Object) PostMove(Object)

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

(Inherited from SfcInstance)
PostRename(Object) PostRename(Object) PostRename(Object)

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

(Inherited from SfcInstance)
Refresh() Refresh() Refresh()

Refreshes the object's properties by reading them from the server.

(Inherited from SfcInstance)
Rename(String) Rename(String) Rename(String)

Renames the environment.

RenameImpl(SfcKey) RenameImpl(SfcKey) RenameImpl(SfcKey)

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

(Inherited from SfcInstance)
ResetKey() ResetKey() ResetKey()

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

(Inherited from SfcInstance)
Revoke(PermissionType, String) Revoke(PermissionType, String) Revoke(PermissionType, String)

Revokes the permission to a specified user.

ScriptAlter() ScriptAlter() ScriptAlter()

Indicates a script to alter the environment.

ScriptCreate() ScriptCreate() ScriptCreate()

Indicates a script to create the environment.

ScriptDeny(PermissionType, Int32) ScriptDeny(PermissionType, Int32) ScriptDeny(PermissionType, Int32)

Indicates the script to deny the permission to an environment.

ScriptDrop() ScriptDrop() ScriptDrop()

Indicates the script to drop the environment.

ScriptGrant(PermissionType, Int32) ScriptGrant(PermissionType, Int32) ScriptGrant(PermissionType, Int32)

Indicates the script to grant the permission to an environment.

ScriptRevoke(PermissionType, Int32) ScriptRevoke(PermissionType, Int32) ScriptRevoke(PermissionType, Int32)

Indicates the script to revoke the permission to an environment.

Serialize(XmlWriter) Serialize(XmlWriter) Serialize(XmlWriter)

Serializes the instance to XML.

(Inherited from SfcInstance)
ToString() ToString() ToString()

Returns a string representation of the instance Urn.

(Inherited from SfcInstance)
UpdateUIPropertyState() UpdateUIPropertyState() UpdateUIPropertyState()

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

(Inherited from SfcInstance)
Validate() Validate() Validate()

Indicates the basic child object's validation. Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SfcInstance)

Explicit Interface Implementations

ISfcDiscoverObject.Discover(ISfcDependencyDiscoveryObjectSink) ISfcDiscoverObject.Discover(ISfcDependencyDiscoveryObjectSink) ISfcDiscoverObject.Discover(ISfcDependencyDiscoveryObjectSink)

Specifies whether to discover children and if their IsCrudActionHandledByParent is false (default), accumulate their CRUD scripts to my action script.

ISfcMovable.Move(SfcInstance) ISfcMovable.Move(SfcInstance) ISfcMovable.Move(SfcInstance)

Moves the EnvironmentInfo object to be a child of another folder.

ISfcMovable.ScriptMove(SfcInstance) ISfcMovable.ScriptMove(SfcInstance) ISfcMovable.ScriptMove(SfcInstance)

Moves the script of the EnvironmentInfo object to be a child of another folder.

ISfcRenamable.Rename(SfcKey) ISfcRenamable.Rename(SfcKey) ISfcRenamable.Rename(SfcKey)

Renames the environment.

ISfcRenamable.ScriptRename(SfcKey) ISfcRenamable.ScriptRename(SfcKey) ISfcRenamable.ScriptRename(SfcKey)

Indicates the script to rename the environment.

Events

propertyChanged propertyChanged propertyChanged

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

(Inherited from SfcInstance)
PropertyChanged PropertyChanged PropertyChanged

Occurs when a property value changes.

(Inherited from SfcInstance)
propertyMetadataChanged propertyMetadataChanged propertyMetadataChanged

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

Occurs when a property metadata value changes.

(Inherited from SfcInstance)
PropertyMetadataChanged PropertyMetadataChanged PropertyMetadataChanged

Occurs when the metadata for a property has changed.

(Inherited from SfcInstance)

Applies to