PSql.xml
|
<?xml version="1.0" encoding="utf-8"?> <doc> <assembly> <name>PSql</name> </assembly> <members> <member name="T:PSql.Cmdlet"> <summary> Base class for PSql cmdlets. </summary> </member> <member name="M:PSql.Cmdlet.WriteHost(System.String,System.Boolean,System.Nullable{System.ConsoleColor},System.Nullable{System.ConsoleColor})"> <summary> Writes the specified message to the host. </summary><param name="message"> The message to write. </param><param name="newLine"> Whether a newline should follow the message. </param><param name="foregroundColor"> The foreground color to use. </param><param name="backgroundColor"> The background color to use. </param><remarks> This method is similar to the PowerShell <c>Write-Host</c> cmdlet. </remarks> </member> <member name="M:PSql.Cmdlet.WriteWarning(System.String)"> <summary> Writes the specified warning message to the host. </summary><remarks> This method is similar to the PowerShell <c>Write-Warning</c> cmdlet. </remarks> </member> <member name="T:PSql.ConnectedCmdlet"> <summary> Base class for PSql cmdlets that use an open database connection. </summary> </member> <member name="T:PSql.ApplicationIntent"> <summary> Kinds of operations that an application can declare it intends to perform against a database. </summary> </member> <member name="F:PSql.ApplicationIntent.ReadWrite"> <summary> The application intends to perform reads and writes. </summary> </member> <member name="F:PSql.ApplicationIntent.ReadOnly"> <summary> The application intends to perform reads only. </summary> </member> <member name="T:PSql.AzureAuthenticationMode"> <summary> Modes for authenticating connections to Azure SQL Database and compatible databases. </summary> </member> <member name="F:PSql.AzureAuthenticationMode.Default"> <summary> Default authentication mode. </summary> <remarks> The actual authentication mode depends on the value of the <see cref="P:PSql.SqlContext.Credential" /> property. If the property is non-<see langword="null" />, this mode selects SQL authentication using the credential. If the property is <see langword="null" />, this mode selects Azure AD managed identity authentication. </remarks> </member> <member name="F:PSql.AzureAuthenticationMode.SqlPassword"> <summary> SQL authentication mode. </summary> <remarks> The <see cref="P:PSql.SqlContext.Credential" /> property should contain the name and password stored for a server login or contained database user. </remarks> </member> <member name="F:PSql.AzureAuthenticationMode.AadPassword"> <summary> Azure Active Directory password authentication mode. </summary> <remarks> The <see cref="P:PSql.SqlContext.Credential" /> property should contain the name and password of an Azure AD principal. </remarks> </member> <member name="F:PSql.AzureAuthenticationMode.AadIntegrated"> <summary> Azure Active Directory integrated authentication mode. </summary> <remarks> The identity of the process should be an Azure AD principal. </remarks> </member> <member name="F:PSql.AzureAuthenticationMode.AadInteractive"> <summary> Azure Active Directory interactive authentication mode, also known as Universal Authentication with MFA. </summary> <remarks> Authentication uses an interactive flow and supports multiple factors. </remarks> </member> <member name="F:PSql.AzureAuthenticationMode.AadServicePrincipal"> <summary> Azure Active Directory service principal authentication mode. </summary> <remarks> The <see cref="P:PSql.SqlContext.Credential" /> property should contain the client ID and secret of an Azure AD service principal. </remarks> </member> <member name="F:PSql.AzureAuthenticationMode.AadDeviceCodeFlow"> <summary> Azure Active Directory device code flow authentication mode. </summary> <remarks> Use this mode to connect to Azure SQL Database from devices that do not provide a web browser, using another device to perform interactive authentication. </remarks> </member> <member name="F:PSql.AzureAuthenticationMode.AadManagedIdentity"> <summary> Azure Active Directory managed identity authentication mode. </summary> <remarks> For a user-assigned managed identity, the <see cref="P:PSql.SqlContext.Credential" /> property's username should be the object ID of the identity; the password is ignored. For a system-assigned managed identity, the <see cref="P:PSql.SqlContext.Credential" /> property should be <see langword="null" />. </remarks> </member> <member name="F:PSql.AzureAuthenticationMode.AadDefault"> <summary> Azure Active Directory default authentication mode. This mode attempts multiple <strong>non-interactive</strong> authentication methods sequentially. </summary> <remarks> <para> This mode attempts in order: </para> <list type="bullet"> <item> <term>Environment</term> <description> Credential <a href="https://docs.microsoft.com/en-ca/dotnet/api/azure.identity.environmentcredential?view=azure-dotnet">configured in environment variables</a>. </description> </item> <item> <term>Managed Identity</term> <description> Azure Active Directory managed identity. For a user-assigned managed identity, the <see cref="P:PSql.SqlContext.Credential" /> property's username should be the object ID of the identity; the password is ignored. For a system-assigned managed identity, the <see cref="P:PSql.SqlContext.Credential" /> property should be <see langword="null" />. </description> </item> <item> <term>Shared Token Cache</term> <description> Local cache shared between Microsoft applications. </description> </item> <item> <term>Visual Studio</term> <description> Token cached by Visual Studio. </description> </item> <item> <term>Visual Studio Code</term> <description> Token cached by Visual Studio Code. </description> </item> <item> <term>Azure CLI</term> <description> Token cached by the Azure CLI. </description> </item> </list> </remarks> </member> <member name="T:PSql.AzureSqlContext"> <summary> Information necessary to connect to an Azure SQL Database or compatible database. </summary> </member> <member name="M:PSql.AzureSqlContext.#ctor"> <summary> Initializes a new <see cref="T:PSql.AzureSqlContext" /> instance with default property values. </summary> </member> <member name="M:PSql.AzureSqlContext.#ctor(PSql.AzureSqlContext)"> <summary> Initializes a new <see cref="T:PSql.AzureSqlContext" /> instance by property values from the specified instance. </summary> <param name="other"> The instance from which to copy property values. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="other" /> is <see langword="null" />. </exception> </member> <member name="P:PSql.AzureSqlContext.IsAzure"> <summary> Gets whether the context is an <see cref="T:PSql.AzureSqlContext" />. </summary> </member> <member name="P:PSql.AzureSqlContext.ServerResourceGroupName"> <summary> Gets or sets the name of the Azure resource group containing the virtual database server. The default is <see langword="null" />. </summary> </member> <member name="P:PSql.AzureSqlContext.ServerResourceName"> <summary> Gets or sets the Azure resource name of the virtual database server. The default is <see langword="null" />. </summary> </member> <member name="P:PSql.AzureSqlContext.AuthenticationMode"> <summary> Gets or sets the method used to authenticate with the database server. The default is <see cref="F:PSql.AzureAuthenticationMode.Default" />. </summary> </member> <member name="P:PSql.AzureSqlContext.EncryptionMode"> <summary> Gets or sets a value that specifies the transport encryption to use for connections. The default is <see cref="F:PSql.EncryptionMode.Default" />. </summary> </member> <member name="P:PSql.AzureSqlContext.Item(System.String,System.String,System.String)"> <summary> Gets a new context that is a copy of the current instance, but with the specified server resource group name, server resource name, and database name. If the current instance is frozen, the copy is frozen also. </summary> <param name="serverResourceGroupName"> The value to set on the copy for the name of the Azure resource group containing the virtual database server. </param> <param name="serverResourceName"> The value to set on the copy for the Azure resource name of the virtual database server. </param> <param name="databaseName"> The value to set on the copy for the name of the database. </param> </member> <member name="M:PSql.AzureSqlContext.Clone"> <summary> Creates a new, non-frozen context that is a copy of the current instance. </summary> </member> <member name="M:PSql.AzureSqlContext.CloneCore"> <summary> Creates a new, non-frozen context that is a copy of the current instance. Subclasses should override this method. </summary> </member> <member name="T:PSql.EncryptionMode"> <summary> Modes for connection encryption and server identity verification. </summary> </member> <member name="F:PSql.EncryptionMode.Default"> <summary> The default encrption mode. Equivalent to <see cref="F:PSql.EncryptionMode.None" /> for connections to the local machine, and <see cref="F:PSql.EncryptionMode.Full" /> for all other connections. </summary> </member> <member name="F:PSql.EncryptionMode.None"> <summary> No connection encryption or server identity check. Data sent over the connection is exposed to other network devices. A malicious device could masquerade as a server. This encryption mode is appropriate for same-machine connections only. </summary> </member> <member name="F:PSql.EncryptionMode.Unverified"> <summary> Connections are encrypted, but server identities are not verified. A malicious device could masquerade as a server. This encryption mode is appropriate only when the server uses a self-signed certificate. </summary> </member> <member name="F:PSql.EncryptionMode.Full"> <summary> Connections are encrypted, and server identities are verified. This is the most secure encryption mode. </summary> </member> <member name="T:PSql.SqlClientVersion"> <summary> Supported SqlClient versions. </summary> </member> <member name="F:PSql.SqlClientVersion.Legacy"> <summary> System.Data.SqlClient </summary> </member> <member name="F:PSql.SqlClientVersion.Mds1"> <summary> Microsoft.Data.SqlClient 1.0.x </summary> </member> <member name="F:PSql.SqlClientVersion.Mds1_1"> <summary> Microsoft.Data.SqlClient 1.1.x </summary> </member> <member name="F:PSql.SqlClientVersion.Mds2"> <summary> Microsoft.Data.SqlClient 2.0.x </summary> </member> <member name="F:PSql.SqlClientVersion.Mds2_1"> <summary> Microsoft.Data.SqlClient 2.1.x </summary> </member> <member name="F:PSql.SqlClientVersion.Mds3"> <summary> Microsoft.Data.SqlClient 3.x </summary> </member> <member name="F:PSql.SqlClientVersion.Mds4"> <summary> Microsoft.Data.SqlClient 4.x </summary> </member> <member name="F:PSql.SqlClientVersion.Mds5"> <summary> Microsoft.Data.SqlClient 5.x </summary> </member> <member name="F:PSql.SqlClientVersion.Latest"> <summary> The latest version supported by the current code. </summary> </member> <member name="T:PSql.SqlContext"> <summary> Information necessary to connect to SQL Server, Azure SQL Database, or compatible product. </summary> </member> <member name="M:PSql.SqlContext.#ctor"> <summary> Initializes a new <see cref="T:PSql.SqlContext" /> instance with default property values. </summary> </member> <member name="M:PSql.SqlContext.#ctor(PSql.SqlContext)"> <summary> Initializes a new <see cref="T:PSql.SqlContext" /> instance by copying property values from the specified instance. </summary> <param name="other"> The instance from which to copy property values. </param> <exception cref="T:System.ArgumentNullException"> <paramref name="other" /> is <see langword="null" />. </exception> </member> <member name="P:PSql.SqlContext.IsAzure"> <summary> Gets whether the context is an <see cref="T:PSql.AzureSqlContext" />. </summary> </member> <member name="P:PSql.SqlContext.AsAzure"> <summary> Gets the context cast to <see cref="T:PSql.AzureSqlContext" />. If the context is a non-Azure context, this property is <see langword="null" />. </summary> </member> <member name="P:PSql.SqlContext.IsLocal"> <summary> Gets whether the context connects to the local computer. </summary> </member> <member name="P:PSql.SqlContext.IsFrozen"> <summary> Gets whether the context is frozen. A frozen context is read-only; its properties cannot be changed. </summary> </member> <member name="P:PSql.SqlContext.ServerName"> <summary> Gets or sets the DNS name of the database server. The values <c>.</c> and <c>(local)</c> are recognized as aliases for the local machine. If <see langword="null" /> or an empty string, behavior is context-dependent: <see cref="T:PSql.SqlContext" /> connects to the local machine, and <see cref="T:PSql.AzureSqlContext" /> connects to the Azure virtual database server identified by the <see cref="P:PSql.AzureSqlContext.ServerResourceGroupName" /> and <see cref="P:PSql.AzureSqlContext.ServerResourceName" /> properties. The default is <see langword="null" />. </summary> </member> <member name="P:PSql.SqlContext.ServerPort"> <summary> Gets or sets the remote TCP port of the database server. If <see langword="null" />, the underlying ADO.NET implementation will use a default port, typically 1433. The default is <see langword="null" />. </summary> </member> <member name="P:PSql.SqlContext.InstanceName"> <summary> Gets or sets the name of the database engine instance. If <see langword="null" />, connection attempts will target the default instance. The default is <see langword="null" />. </summary> </member> <member name="P:PSql.SqlContext.DatabaseName"> <summary> Gets or sets the name of the database. If <see langword="null" />, connections will attempt to open in the default database of the authenticated user. The default is <see langword="null" />. </summary> </member> <member name="P:PSql.SqlContext.Credential"> <summary> Gets or sets the credential to use to authenticate with the database server. The default is <see langword="null" />. </summary> <remarks> <para> For <see cref="T:PSql.AzureSqlContext" />, the use of this property depends on the authentication mode. For details, see the <see cref="P:PSql.AzureSqlContext.AuthenticationMode" /> property. </para> <para> For non-Azure contexts, if <c>Credential</c> is not <see langword="null" />, connections will use SQL passwor authentication. If this property is <see langword="null" />, connections will use integrated authentication. </para> </remarks> </member> <member name="P:PSql.SqlContext.EncryptionMode"> <summary> Gets or sets a value that specifies the transport encryption to use for connections. The default is <see cref="F:PSql.EncryptionMode.Default" />. </summary> </member> <member name="P:PSql.SqlContext.ConnectTimeout"> <summary> Gets or sets the duration after which a connection attempt times out. If <see langword="null" />, the underlying ADO.NET implementation default of 15 seconds is used. </summary> </member> <member name="P:PSql.SqlContext.ClientName"> <summary> Gets or sets the name of the client device. If <see langword="null" />, the underlying ADO.NET implementation will provide a default value. </summary> </member> <member name="P:PSql.SqlContext.ApplicationName"> <summary> Gets or sets the name of the client application. If <see langword="null" />, the underlying ADO.NET implementation will provide a default value. </summary> </member> <member name="P:PSql.SqlContext.ApplicationIntent"> <summary> Gets or sets a value that declares the kinds of operations that the client application intends to perform against databases. The default is <see cref="F:PSql.ApplicationIntent.ReadWrite" />. </summary> </member> <member name="P:PSql.SqlContext.ExposeCredentialInConnectionString"> <summary> Gets or sets whether the credential used for authentication should be exposed in the <see cref="P:System.Data.Common.DbConnection.ConnectionString" /> property. This is a potential security risk, so use only when necessary. The default is <see langword="false" />. </summary> </member> <member name="P:PSql.SqlContext.EnableConnectionPooling"> <summary> Gets or sets whether connections may be pooled to reduce setup and teardown time. Pooling is useful when making many connections with identical connection strings. The default is <see langword="false" />. </summary> </member> <member name="P:PSql.SqlContext.EnableMultipleActiveResultSets"> <summary> Gets or sets whether connections support execution of multiple batches concurrently, with limitations. The default is <see langword="false" />. For more information, see <a href="https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/sql/multiple-active-result-sets-mars">Multiple Active Result Sets (MARS)</a>. </summary> </member> <member name="P:PSql.SqlContext.Item(System.Management.Automation.ScriptBlock)"> <summary> Gets a new context that is a copy of the current instance, then modified by the specified script block. If the current instance is frozen, the copy becomes frozen after the script block ends. </summary> <param name="block"> A script block that can modify the created context. Inside the script block, the variable <c>$_</c> holds the created context. </param> </member> <member name="P:PSql.SqlContext.Item(System.String)"> <summary> Gets a new context that is a copy of the current instance, but with the specified database name. If the current instance is frozen, the copy is frozen also. </summary> <param name="databaseName"> The name of the database to set on the copy. </param> </member> <member name="P:PSql.SqlContext.Item(System.String,System.String)"> <summary> Gets a new context that is a copy of the current instance, but with the specified server name and database name. If the current instance is frozen, the copy is frozen also. </summary> <param name="serverName"> The name of the server to set on the copy. </param> <param name="databaseName"> The name of the database to set on the copy. </param> </member> <member name="M:PSql.SqlContext.Clone"> <summary> Creates a new, non-frozen context that is a copy of the current instance. </summary> </member> <member name="M:PSql.SqlContext.System#ICloneable#Clone"> <summary>Creates a new object that is a copy of the current instance.</summary><returns>A new object that is a copy of this instance.</returns> </member> <member name="M:PSql.SqlContext.CloneCore"> <summary> Creates a new, non-frozen context that is a copy of the current instance. Subclasses should override this method. </summary> </member> <member name="M:PSql.SqlContext.Freeze"> <summary> Freezes the context if it is not frozen already. Once frozen, the properties of the context cannot be changed. </summary> </member> <member name="M:PSql.SqlContext.GetEffectiveServerName"> <summary> Returns the effective DNS name of the database server. If the <see cref="P:PSql.SqlContext.ServerName" /> property is neither <see langword="null" /> nor empty, this method returns the property value. Otherwise, behavior is context-dependent. For <see cref="T:PSql.SqlContext" />, this method returns an alias for the local machine. For <see cref="T:PSql.AzureSqlContext" />, this method returns the DNS name of the Azure virtual database server identified by the <see cref="P:PSql.AzureSqlContext.ServerResourceGroupName" /> and <see cref="P:PSql.AzureSqlContext.ServerResourceName" /> properties. </summary> </member> <member name="M:PSql.SqlContext.GetConnectionString(System.String,PSql.SqlClientVersion,System.Boolean)"> <summary> Gets a connection string built from the property values of the current context, optionally with the specified database name, compatibility, and/or credential disclosure. </summary> <param name="databaseName"> The name of the database to specify in the connection string. If not <see langword="null" />, this parameter overrides the value of the <see cref="P:PSql.SqlContext.DatabaseName" /> property. The default is <see langword="null" />. </param> <param name="sqlClientVersion"> The SqlClient version with which the generated connection string should be compatible. The default is <see cref="F:PSql.SqlClientVersion.Legacy" />. </param> <param name="omitCredential"> <para> Whether to omit credential properties from the generated connection string if possible. Use <see langword="true" /> when passing the credential separately from the connection string (for example, as a <c>SqlCredential</c> object). The default is <see langword="false" />. </para> <para> Note that the <see cref="P:PSql.SqlContext.ExposeCredentialInConnectionString" /> takes precedence over this this parameter. If the property is <see langword="true" />, the generated connection string will include credential properties regardless of this parameter. </para> </param> <returns> A connection string compatible with <paramref name="sqlClientVersion" /> built from the property values of the current context and, if specified, <paramref name="databaseName" />. If <paramref name="omitCredential" /> is <see langword="true" />, the connection string will not include credential properties. </returns> </member> <member name="T:PSql.PSqlDependencyResolutionHandler"> <summary> Module initialization and cleanup handler that configures dependency resolution. </summary> <remarks> This type is part of the dependency isolation technique described <a href="https://learn.microsoft.com/en-us/powershell/scripting/dev-cross-plat/resolving-dependency-conflicts">here</a>. </remarks> </member> <member name="M:PSql.PSqlDependencyResolutionHandler.System#Management#Automation#IModuleAssemblyInitializer#OnImport"> <summary> Invoked by PowerShell when the module is imported into a runspace. </summary> </member> <member name="M:PSql.PSqlDependencyResolutionHandler.System#Management#Automation#IModuleAssemblyCleanup#OnRemove(System.Management.Automation.PSModuleInfo)"> <summary> Invoked by PowerShell when the module is removed from a runspace. </summary> <param name="module"> The module being removed. </param> </member> <member name="T:PSql.SqlConnectionStringBuilder"> <summary> A simple, append-only connection string builder that supportes multiple SqlClient versions. </summary> </member> <member name="M:PSql.SqlConnectionStringBuilder.#ctor(PSql.SqlClientVersion)"> <summary> Initializes a new <see cref="T:PSql.SqlConnectionStringBuilder" /> instance for the specified SqlClient version. </summary> <param name="version"> The SqlClient version against which the builder should maintain compatibility. </param> </member> <member name="P:PSql.SqlConnectionStringBuilder.Version"> <summary> Gets the SqlClient version against which the builder maintains compatibility. </summary> </member> <member name="M:PSql.SqlConnectionStringBuilder.AppendServerName(System.String)"> <summary> Appends a property that specifies the name or network address of the SQL Server, Azure SQL Database, or compatible product instance to which to connect. </summary> </member> <member name="M:PSql.SqlConnectionStringBuilder.AppendDatabaseName(System.String)"> <summary> Appends a property that specifies the name of the database to which to connect. </summary> </member> <member name="M:PSql.SqlConnectionStringBuilder.AppendIntegratedSecurity(System.Boolean)"> <summary> Appends a property that specifies to use the current user identity for authentication. </summary> </member> <member name="M:PSql.SqlConnectionStringBuilder.AppendAuthenticationMode(PSql.AzureAuthenticationMode)"> <summary> Appends a property that specifies the authentication mode. </summary> </member> <member name="M:PSql.SqlConnectionStringBuilder.AppendCredential(System.Net.NetworkCredential)"> <summary> Appends properties that specify the username and password for authentication. </summary> </member> <member name="M:PSql.SqlConnectionStringBuilder.AppendUserName(System.String)"> <summary> Appends a property that specifies the username for authentication. </summary> </member> <member name="M:PSql.SqlConnectionStringBuilder.AppendPassword(System.String)"> <summary> Appends a property that specifies the password for authentication. </summary> </member> <member name="M:PSql.SqlConnectionStringBuilder.AppendPersistSecurityInfo(System.Boolean)"> <summary> Appends a property that specifies whether security-sensitive information such as password appears in a connection's <see cref="P:System.Data.Common.DbConnection.ConnectionString" /> property after the connection transitions to the open state. </summary> </member> <member name="M:PSql.SqlConnectionStringBuilder.AppendEncrypt(System.Boolean)"> <summary> Appends a property that specifies whether to encrypt data sent between between client and server if the server supports encryption. </summary> </member> <member name="M:PSql.SqlConnectionStringBuilder.AppendTrustServerCertificate(System.Boolean)"> <summary> Appends a property that specifies whether to skip verification of the chain of trust of the certificate the server presents for encryption. </summary> </member> <member name="M:PSql.SqlConnectionStringBuilder.AppendConnectTimeout(System.TimeSpan)"> <summary> Appends a property that specifies the duration to wait for a connection to become established before terminating the attempt and throwing an exception. </summary> </member> <member name="M:PSql.SqlConnectionStringBuilder.AppendClientName(System.String)"> <summary> Appends a property that specifies the client machine name to associate with connections. </summary> </member> <member name="M:PSql.SqlConnectionStringBuilder.AppendApplicationName(System.String)"> <summary> Appends a property that specifies the client application name to associate with connections. </summary> </member> <member name="M:PSql.SqlConnectionStringBuilder.AppendApplicationIntent(PSql.ApplicationIntent)"> <summary> Appends a property that specifies the kind of operations the client intends to perform using connections. </summary> </member> <member name="M:PSql.SqlConnectionStringBuilder.AppendMultipleActiveResultSets(System.Boolean)"> <summary> Appends a property that specifies whether connections will support multiple active result sets. </summary> </member> <member name="M:PSql.SqlConnectionStringBuilder.AppendPooling(System.Boolean)"> <summary> Appends a property that specifies whether connections will participate in pooling. </summary> </member> <member name="M:PSql.SqlConnectionStringBuilder.ToString"> <summary> Returns the current connection string built by this instance. </summary> </member> <member name="M:PSql.ConnectedCmdlet.System#IDisposable#Dispose"> <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary> </member> </members> </doc> |