EnvironmentInfo Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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[<Microsoft.SqlServer.Management.Sdk.Sfc.LocalizedPropertyResources("Microsoft.SqlServer.Management.IntegrationServices.LocalizableResources")>]
[<System.ComponentModel.TypeConverter(typeof(Microsoft.SqlServer.Management.Sdk.Sfc.LocalizableTypeConverter))>]
type EnvironmentInfo = class
inherit SfcInstance
interface ISfcCreatable
interface ICreatable
interface ISfcAlterable
interface IAlterable
interface IRenamable
interface ISfcRenamable
interface ISfcDiscoverObject
interface ISfcDroppable
interface IDroppable
interface ISfcMovablePublic NotInheritable Class EnvironmentInfo
Inherits SfcInstance
Implements IAlterable, ICreatable, IDroppable, IRenamable, ISfcAlterable, ISfcCreatable, ISfcDroppable, ISfcMovable, ISfcRenamable- Inheritance
- Attributes
- Implements
Constructors
| EnvironmentInfo(CatalogFolder, String, String) |
Initializes a new instance of the EnvironmentInfo class with the specified parent, name and description. |
Properties
| AbstractIdentityKey |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| Description |
Gets or sets the description of the environment. |
| EnvironmentId |
Gets the identifier of the environment. |
| IdentityKey |
Gets the identity key. |
| Metadata |
Returns metadata about the instance and its domain. (Inherited from SfcInstance) |
| Name |
Gets or sets the name of the environment. |
| Parent |
Gets or sets the parent. |
| Properties |
Returns a collection instance properties. (Inherited from SfcInstance) |
| PropertyStorageProvider |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| State |
Returns the state of the SfcInstance object. (Inherited from SfcInstance) |
| Urn |
Returns the uniform resource name of the SfcInstance object. (Inherited from SfcInstance) |
| Variables |
Gets the variables in the environment. |
Methods
| Alter() |
Alters the environment in the back-end server. |
| AlterImpl() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| CheckObjectCreated() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| CheckObjectState() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| Create() |
Creates the EnvironmentInfo object in the back-end server. |
| CreateIdentityKey() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| CreateImpl() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| Deny(PermissionType, String) |
Denies the permission to a specified user. |
| Discover(ISfcDependencyDiscoveryObjectSink) |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| Drop() |
Removes the EnvironmentInfo object in the back-end server. |
| DropImpl() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| GetChildCollection(String) |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| GetDomain() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| GetEffectivePermissions() |
Retrieves the effective permissions of the EnvironmentInfo object. |
| GetExplicitPermissions() |
Retrieves the explicit permissions of the EnvironmentInfo object. |
| GetExplicitPermissions(String) |
Retrieves the explicit permissions of the EnvironmentInfo object for a specified user. |
| GetObjectFactory() |
Retrieves the factory to create a new instance. |
| GetPropertySet() |
Returns the set of properties for the SfcInstance object. (Inherited from SfcInstance) |
| 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) |
Grants the permission to a specified user. |
| InitializeUIPropertyState() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| 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() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| Move(String) |
Moves the EnvironmentInfo object to be a child of another folder. |
| 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) |
Invoked whenever the effective value of any SfcInstance metadata is updated. (Inherited from SfcInstance) |
| OnPropertyValueChanges(PropertyChangedEventArgs) |
Invoked whenever the effective value of any SfcInstance property is updated. (Inherited from SfcInstance) |
| PostAlter(Object) |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| 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) |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| PostMove(Object) |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| PostRename(Object) |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| Refresh() |
Refreshes the object's properties by reading them from the server. (Inherited from SfcInstance) |
| Rename(String) |
Renames the environment. |
| RenameImpl(SfcKey) |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| ResetKey() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| Revoke(PermissionType, String) |
Revokes the permission to a specified user. |
| ScriptAlter() |
Indicates a script to alter the environment. |
| ScriptCreate() |
Indicates a script to create the environment. |
| ScriptDeny(PermissionType, Int32) |
Indicates the script to deny the permission to an environment. |
| ScriptDrop() |
Indicates the script to drop the environment. |
| ScriptGrant(PermissionType, Int32) |
Indicates the script to grant the permission to an environment. |
| ScriptRevoke(PermissionType, Int32) |
Indicates the script to revoke the permission to an environment. |
| Serialize(XmlWriter) |
Serializes the instance to XML. (Inherited from SfcInstance) |
| ToString() |
Returns a string representation of the instance Urn. (Inherited from SfcInstance) |
| UpdateUIPropertyState() |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| 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) |
Events
| propertyChanged |
Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SfcInstance) |
| PropertyChanged |
Occurs when a property value changes. (Inherited from SfcInstance) |
| 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 |
Occurs when the metadata for a property has changed. (Inherited from SfcInstance) |
Explicit Interface Implementations
| 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) |
Moves the EnvironmentInfo object to be a child of another folder. |
| ISfcMovable.ScriptMove(SfcInstance) |
Moves the script of the EnvironmentInfo object to be a child of another folder. |
| ISfcRenamable.Rename(SfcKey) |
Renames the environment. |
| ISfcRenamable.ScriptRename(SfcKey) |
Indicates the script to rename the environment. |