qbo4.Infrastructure.Powershell.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>qbo4.Infrastructure.Powershell</name> </assembly> <members> <member name="T:qbo4.Infrastructure.Powershell.PublishCloudformationEnvironmentCmdlet"> <summary> Standup a QBO environment </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.UnpublishCloudformationEnvironmentCmdlet"> <summary> Teardown a QBO environment </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.WatchCloudformationEnvironmentCmdlet"> <summary> Wait for a QBO environment to complete standup </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.Extensions.LoggingBuilderExtensions"> <summary> Extension methods for <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder"/> </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.Extensions.LoggingBuilderExtensions.AddCmdletLogger(Microsoft.Extensions.Logging.ILoggingBuilder,Microsoft.Extensions.Logging.ILogger)"> <summary> Add the Powershell CmdletLoggerProvider. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.PublishSqlDatabaseCmdlet"> <summary> Deploys dacpacs to a target database. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.PublishSqlDatabaseCmdlet.Database"> <summary> Name of the database. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.PublishSqlDatabaseCmdlet.ConnectionString"> <summary> Connection string such as 'Data Source=(localdb)\MSSQLLocalDB;Integrated Security=True;' </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.PublishSqlDatabaseCmdlet.DacPacPath"> <summary> Path to the .dacpac files to publish. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.PublishSqlDatabaseCmdlet.ProfilePath"> <summary> Path to the publish.xml file containing SqlCmdVariables. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.PublishSqlDatabaseCmdlet.ProcessRecordAsync"> <summary> Execute Deployment. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.ScriptSqlDatabaseCmdlet"> <summary> Creates a DB script to update an existing database to current dacpacs. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.ScriptSqlDatabaseCmdlet.Database"> <summary> Name of the database. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.ScriptSqlDatabaseCmdlet.ConnectionString"> <summary> Connection string such as 'Data Source=(localdb)\MSSQLLocalDB;Integrated Security=True;' </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.ScriptSqlDatabaseCmdlet.DacPacPath"> <summary> Path to the .dacpac files to publish. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.ScriptSqlDatabaseCmdlet.ScriptPath"> <summary> Path to script file. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.ScriptSqlDatabaseCmdlet.ProfilePath"> <summary> Path to the publish.xml file containing SqlCmdVariables. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.ScriptSqlDatabaseCmdlet.ProcessRecordAsync"> <summary> Execute Deployment. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.SetSqlUser.UserName"> <summary> SqlServer username to use for application connection string. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.SetSqlUser.Password"> <summary> SqlServer password to use for application connection string. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.SetSqlUser.Database"> <summary> Name of the database. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.SetSqlUser.ConnectionString"> <summary> Connection string such as 'Data Source=(localdb)\MSSQLLocalDB;Integrated Security=True;' </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.SetSqlUser.Role"> <summary> Optional SQL Server role, default is db_owner </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.GetSqlDatabaseCmdlet"> <summary> Downloads a Nuget package with .dacpac files. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.GetSqlDatabaseCmdlet.Package"> <summary> Nuget package containing .dacpacs; e.g. qbo3.Fintech.Dacpac </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.GetSqlDatabaseCmdlet.Feed"> <summary> Version to download. If not specified, the latest will be used. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.GetSqlDatabaseCmdlet.Version"> <summary> Version to download. If not specified, the latest will be used. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.GetSqlDatabaseCmdlet.ProcessRecordAsync"> <summary> Execute Deployment. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.ConfirmConnectionCmdlet"> <summary> <para type="synopsis">Attempts to connect to a database using a connection string.</para> <para type="link" uri="https://dev.azure.com/quandisopensource/Documentation/_wiki/wikis/Documentation.wiki/213/Installation-Guide">QBO Installation Guide.</para> </summary> <example> <code>confirm-qboConnectionString "Data Source=(localdb)\MSSQLLocalDB;Trusted Connection=true;"</code> </example> </member> <member name="P:qbo4.Infrastructure.Powershell.ConfirmConnectionCmdlet.ConnectionString"> <summary> <para type="description">Connection string to database.</para> </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.ConfirmConnectionCmdlet.Query"> <summary> <para type="description">Connection string to database.</para> </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.ConfirmConnectionCmdlet.ProcessRecordAsync(System.Threading.CancellationToken)"> <summary> Execute Deployment. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.QueryCmdlet"> <summary> <para type="synopsis">Attempts to connect to a database using a connection string.</para> <para type="link" uri="https://dev.azure.com/quandisopensource/Documentation/_wiki/wikis/Documentation.wiki/213/Installation-Guide">QBO Installation Guide.</para> </summary> <example> <code>confirm-qboConnectionString "Data Source=(localdb)\MSSQLLocalDB;Trusted Connection=true;"</code> </example> </member> <member name="P:qbo4.Infrastructure.Powershell.QueryCmdlet.ConnectionString"> <summary> <para type="description">Connection string to database.</para> </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.QueryCmdlet.Query"> <summary> <para type="description">Query to execute.</para> </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.QueryCmdlet.ProcessRecordAsync(System.Threading.CancellationToken)"> <summary> Execute Deployment. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.WebManagerCmdlet.PackagePath"> <summary> Web deployment package path (.zip file). </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.WebManagerCmdlet.ComputerName"> <summary> Target computer to deploy to. Defaults to 127.0.0.1 (localhost). </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.WebManagerCmdlet.PhysicalPath"> <summary> Web site physical path (root of website). </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.AsyncPump"> <summary> Provides a pump that supports running asynchronous methods on the current thread. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.AsyncPump.Run(System.Func{System.Threading.Tasks.Task})"> <summary>Runs the specified asynchronous function.</summary> <param name="func">The asynchronous function to execute.</param> </member> <member name="T:qbo4.Infrastructure.Powershell.AsyncPump`1"> <summary> Provides a pump that supports running asynchronous methods on the current thread. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.AsyncPump`1.Run(System.Func{System.Threading.Tasks.Task{`0}})"> <summary>Runs the specified asynchronous function.</summary> <param name="func">The asynchronous function to execute.</param> </member> <member name="T:qbo4.Infrastructure.Powershell.AwsTransferCmdlet"> <summary> Manage sFTP users on AWS Transfer. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.NewFtpUserCmdlet"> <summary> Add a user. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.NewFtpUserCmdlet.KeyFile"> <summary> Name of file to write a private key to. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.NewFtpUserCmdlet.Profile"> <summary> AWS Security profile to use. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.RemoveFtpUserCmdlet"> <summary> Remove a user. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.GetFtpServerCmdlet"> <summary> Get server information. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.GetFtpServerCmdlet.Profile"> <summary> AWS Security profile to use. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.CmdletLogger"> <summary> ILogger implementation to interface with Powershell logging. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.CmdletLogger.LogInformationAsVerbose"> <summary> When true, <see cref="!:LogLevel.Information"/> entries will be written to verbose. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.CmdletLogger.LogTraceAsVerbose"> <summary> When true, <see cref="!:LogLevel.Trace"/> entries will be written to verbose. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.CmdletLogger.#ctor(System.Management.Automation.Cmdlet,System.String)"> <summary> Constructor. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.CmdletLogger.BeginScope``1(``0)"> <summary> Scoped logging not supported here. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.CmdletLogger.IsEnabled(Microsoft.Extensions.Logging.LogLevel)"> <summary> Always true. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.CmdletLogger.Log``1(Microsoft.Extensions.Logging.LogLevel,Microsoft.Extensions.Logging.EventId,``0,System.Exception,System.Func{``0,System.Exception,System.String})"> <summary> Logs written need to be cached until they can be written to the main PSCmdLet's thread. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.CmdletLogger.WriteLogs(System.Management.Automation.Cmdlet,System.Boolean,System.Boolean)"> <summary> Writes <see cref="F:qbo4.Infrastructure.Powershell.CmdletLogger.LogEntries"/> to the <see cref="F:qbo4.Infrastructure.Powershell.CmdletLogger._cmdlet"/>. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.CmdletLogger`1"> <summary> Creates a <see cref="T:qbo4.Infrastructure.Powershell.CmdletLogger"/> with a category name based on {T}. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.CmdletLogger`1.#ctor(System.Management.Automation.Cmdlet)"> <summary> Constructor. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.CmdLetLoggerProvider"> <summary> <see cref="T:Microsoft.Extensions.Logging.ILoggerProvider"/> for <see cref="T:qbo4.Infrastructure.Powershell.CmdletLogger"/>. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.CmdLetLoggerProvider.CreateLogger(System.String)"> <summary> Create a <see cref="T:Microsoft.Extensions.Logging.ILogger"/> based on <see cref="F:qbo4.Infrastructure.Powershell.QboCmdlet.CurrentCmdlet"/>. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.CmdLetLoggerProvider.Dispose"> <summary> Nothing to dispose. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.ConfigurationCmdlet.Credentials"> <summary> Manage credentials via IConfiguration. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.GetConfigurationCmdlet"> <summary> <para type="synopsis">Returns the configuration entries used by the qbo4.Infrastructure module.</para> <para type="description">Configuration is stored using dotnet user-secrets under the id 'qbo4.Infrastructure'.</para> <para type="link" uri="https://dev.azure.com/quandisopensource/Documentation/_wiki/wikis/Documentation.wiki/213/Installation-Guide">QBO Installation Guide.</para> </summary> <example> <para>This will return all configuration:</para> <code>get-qboConfig</code> </example> <example> <para>This will return all keys starting with 'Aws':</para> <code>get-qboConfig -section Aws</code> </example> <example> <para>This will return the 'Aws:Region' value:</para> <code>get-qboConfig -key Aws:Region</code> </example> </member> <member name="P:qbo4.Infrastructure.Powershell.GetConfigurationCmdlet.Key"> <summary> <para type="description">Exact configuration key, such as Aws:Region</para> </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.GetConfigurationCmdlet.Section"> <summary> <para type="description">Configuration section, such as Aws</para> </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.SetConfigurationCmdlet"> <summary> <para type="synopsis">Sets a configuration value in memory.</para> <para type="description"> This sets or overrides a configuration value in memory. To persist across sessions, use Save-qboConfig to persist the configuration values to dotnet user-secrets. </para> <para type="link" uri="https://dev.azure.com/quandisopensource/Documentation/_wiki/wikis/Documentation.wiki/213/Installation-Guide">QBO Installation Guide.</para> </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.SaveConfigurationCmdlet"> <summary> <para type="synopsis">Saves configuration using dotnet user-secrets.</para> <para type="description">This requires the dotnet CLI.</para> <para type="link" uri="https://dev.azure.com/quandisopensource/Documentation/_wiki/wikis/Documentation.wiki/213/Installation-Guide">QBO Installation Guide.</para> </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.ReadConfigurationCmdlet"> <summary> Reads a key from configuration, prompting the user for input if the configuration does not contain the key. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.ReadConfigurationCmdlet.Key"> <summary> Key to read. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.ReadConfigurationCmdlet.Prompt"> <summary> Prompt to present to user, if needed. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.ReadConfigurationCmdlet.Save"> <summary> If true, the value will be saved to configuration. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.ReadConfigurationCmdlet.Secure"> <summary> If true, the value will be saved to configuration. </summary> </member> <member name="F:qbo4.Infrastructure.Powershell.RegisterConfigurationCmdlet.assemblies"> <summary> Enable forcing use of assemblies that come with this Powershell module, since Powershell does not offer assembly binding redirects. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.RegisterConfigurationCmdlet.BindingRedirect(System.Object,System.ResolveEventArgs)"> <summary> Manage assembly binding. If an assembly is requested that is already loaded, use it, regardless of version. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.SetCredentialCmdlet"> <summary> <para type="synopsis">Sets a credential in configuration.</para> <para type="description"> If the credential already exists in configuration, this will overwrite it. Otherwise, it will be added to configuration. Note that it will not be persisted across sessions unless you issue: Save-qboConfiguration </para> <para type="link" uri="https://dev.azure.com/quandisopensource/Documentation/_wiki/wikis/Documentation.wiki/213/Installation-Guide">QBO Installation Guide.</para> </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.SetCredentialCmdlet.Uri"> <summary> Uri for credential. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.SetCredentialCmdlet.Username"> <summary> Username. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.SetCredentialCmdlet.Password"> <summary> Password. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.SetCredentialCmdlet.AuthType"> <summary> Authentication type; defaults to Basic. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.GetCredentialCmdlet"> <summary> <para type="synopsis">Gets a credential from configuration.</para> <para type="description">Returns a NetworkCredential from configuration.</para> <para type="link" uri="https://dev.azure.com/quandisopensource/Documentation/_wiki/wikis/Documentation.wiki/213/Installation-Guide">QBO Installation Guide.</para> </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.GetCredentialCmdlet.Uri"> <summary> Uri for credential. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.GetCredentialCmdlet.AuthType"> <summary> Authentication type; defaults to Basic. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.ResetConfigurationCmdlet"> <summary> Reloads <see cref="N:qbo4.Configuration"/> from <see cref="P:qbo4.Infrastructure.Powershell.ResetConfigurationCmdlet.ConfigFile"/>. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.ResetConfigurationCmdlet.ConfigFile"> <summary> Path to configuration file to load. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.ResetConfigurationCmdlet.Project"> <summary> Project to load configuration for. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.GetDynamoSecretCmdlet"> <summary> Gets a secret via <see cref="T:qbo4.Infrastructure.Aws.KeyManagement.DynamoSecretManager"/>. </summary> </member> <member name="F:qbo4.Infrastructure.Powershell.GetDynamoSecretCmdlet.ConfigSection"> <summary> AwsConfigOptions </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.GetDynamoSecretCmdlet.Name"> <summary> Name of secret. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.GetDynamoSecretCmdlet.Application"> <summary> Appliation secret is associated with. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.GetDynamoSecretCmdlet.DynamoTable"> <summary> Dynamo table used to store secrets. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.SetDynamoSecretCmdlet"> <summary> Sets a secret via <see cref="T:qbo4.Infrastructure.Aws.KeyManagement.DynamoSecretManager"/>. </summary> </member> <member name="F:qbo4.Infrastructure.Powershell.SetDynamoSecretCmdlet.ConfigSection"> <summary> AwsConfigOptions </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.SetDynamoSecretCmdlet.Name"> <summary> Name of secret. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.SetDynamoSecretCmdlet.Value"> <summary> Value of secret. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.SetDynamoSecretCmdlet.CryptoKey"> <summary> Name of cryptokey to use </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.SetDynamoSecretCmdlet.Application"> <summary> Application the secret applies to. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.SetDynamoSecretCmdlet.DynamoTable"> <summary> Table the secret applies to. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.GetPackageCmdlet"> <summary> <para type="synopsis">Downloads a Nuget package, returning the location of the downloaded Nuget package.</para> <para type="link" uri="https://dev.azure.com/quandisopensource/Documentation/_wiki/wikis/Documentation.wiki/213/Installation-Guide">QBO Installation Guide.</para> </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.GetPackageCmdlet.Package"> <summary> Nuget package containing .dacpacs; e.g. qbo3.Fintech.Dacpac </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.GetPackageCmdlet.Feed"> <summary> Version to download. If not specified, the latest will be used. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.GetPackageCmdlet.Version"> <summary> Version to download. If not specified, the latest will be used. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.GetPackageCmdlet.ProcessRecordAsync"> <summary> Execute Deployment. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.PublishPackageCmdlet"> <summary> <para type="synopsis">Downloads a Nuget package, and installs the contents to a website's root folder.</para> <para type="description"> Content is copied to the root of the website, and assemblies are copied to the bin folder. If a Nuget package content is older than the target website, it will be ignored. </para> <para type="link" uri="https://dev.azure.com/quandisopensource/Documentation/_wiki/wikis/Documentation.wiki/213/Installation-Guide">QBO Installation Guide.</para> </summary> <example> <para>Install the qbo4.Document.Bridge plugin.</para> <code>publish-qboPackage qbo4.Document.Bridge -website c:\inetpub\wwwroot</code> </example> </member> <member name="P:qbo4.Infrastructure.Powershell.PublishPackageCmdlet.Package"> <summary> Nuget package containing .dacpacs; e.g. qbo3.Fintech.Dacpac </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.PublishPackageCmdlet.SiteName"> <summary> Target path to install to </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.PublishPackageCmdlet.Target"> <summary> Target path to install to </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.PublishPackageCmdlet.Feed"> <summary> Version to download. If not specified, the latest will be used. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.PublishPackageCmdlet.Framework"> <summary> Version to download. If not specified, the latest will be used. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.PublishPackageCmdlet.Version"> <summary> Version to download. If not specified, the latest will be used. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.PublishPackageCmdlet.PackagesConfigTarget"> <summary> Path to Packages.config containing previously installed packages. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.PublishPackageCmdlet.Reinstall"> <summary> When true, matching versions will be re-installed. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.PublishPackageCmdlet.ProcessRecordAsync"> <summary> Execute Deployment. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.PublishPackagesCmdlet"> <summary> <para type="synopsis">Downloads a Nuget package containing a packages.config file, and installs each package to a website's root folder.</para> <para type="description"> Content is copied to the root of the website, and assemblies are copied to the bin folder. If a Nuget package content is older than the target website, it will be ignored. </para> <para type="link" uri="https://dev.azure.com/quandisopensource/Documentation/_wiki/wikis/Documentation.wiki/213/Installation-Guide">QBO Installation Guide.</para> </summary> <example> <para>Install a basic qbo3 website based on the qbo3.Fintech.Local Nuget package.</para> <code>publish-qboPackage qbo3.FinTech.Local -website c:\inetpub\wwwroot</code> </example> <example> <para>Install a basic qbo3 website targeting net472.</para> <code>publish-qboPackage qbo3.FinTech.Local -website c:\inetpub\wwwroot -framework net472</code> </example> </member> <member name="P:qbo4.Infrastructure.Powershell.PublishPackagesCmdlet.Package"> <summary> Nuget package containing .dacpacs; e.g. qbo3.Fintech.Dacpac </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.PublishPackagesCmdlet.SiteName"> <summary> Target websote name to install to. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.PublishPackagesCmdlet.Target"> <summary> Target path to install to. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.PublishPackagesCmdlet.Feed"> <summary> Version to download. If not specified, the latest will be used. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.PublishPackagesCmdlet.Framework"> <summary> Version to download. If not specified, the latest will be used. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.PublishPackagesCmdlet.Version"> <summary> Version to download. If not specified, the latest will be used. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.PublishPackagesCmdlet.Reinstall"> <summary> When true, matching versions will be re-installed. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.PublishPackagesCmdlet.ProcessRecordAsync"> <summary> Execute Deployment. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.UpdatePacakgeFileCmdlet"> <summary> <para type="synopsis">Downloads a Nuget package containing a packages.config file, and installs each package to a website's root folder.</para> <para type="description"> Content is copied to the root of the website, and assemblies are copied to the bin folder. If a Nuget package content is older than the target website, it will be ignored. </para> <para type="link" uri="https://dev.azure.com/quandisopensource/Documentation/_wiki/wikis/Documentation.wiki/213/Installation-Guide">QBO Installation Guide.</para> </summary> <example> <para>Install a basic qbo3 website based on the qbo3.Fintech.Local Nuget package.</para> <code>publish-qboPackage qbo3.FinTech.Local -website c:\inetpub\wwwroot</code> </example> <example> <para>Install a basic qbo3 website targeting net472.</para> <code>publish-qboPackage qbo3.FinTech.Local -website c:\inetpub\wwwroot -framework net472</code> </example> </member> <member name="P:qbo4.Infrastructure.Powershell.UpdatePacakgeFileCmdlet.Source"> <summary> Nuget packages.config or .csproj to read from. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.UpdatePacakgeFileCmdlet.Target"> <summary> Nuget packages.config to write to. If not specified, <see cref="P:qbo4.Infrastructure.Powershell.UpdatePacakgeFileCmdlet.Source"/> will be used. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.UpdatePacakgeFileCmdlet.Feed"> <summary> Feed to use. Defaults to qbo3. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.UpdatePacakgeFileCmdlet.IncludePreRelease"> <summary> If true, prerelease versions will be allowed. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.UpdatePacakgeFileCmdlet.Pattern"> <summary> Package pattern to match. E.g. "qbo*" will update all packages starting with "qbo". Defaults to "*". </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.UpdatePacakgeFileCmdlet.ProcessRecordAsync"> <summary> Execute Deployment. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.QboAsyncCmdlet"> <summary> Async <see cref="T:qbo4.Infrastructure.Powershell.QboCmdlet"/>. </summary> </member> <member name="F:qbo4.Infrastructure.Powershell.QboAsyncCmdlet._cancellationSource"> <summary> Default cancellection source </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.QboAsyncCmdlet.ProcessRecordAsync"> <summary> Implemented by derived class. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.QboAsyncCmdlet.ProcessRecordAsync(System.Threading.CancellationToken)"> <summary> Implemented by derived class. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.QboAsyncCmdlet.ProcessRecord"> <summary> Runs <see cref="M:qbo4.Infrastructure.Powershell.QboAsyncCmdlet.ProcessRecordAsync"/> via a common <see cref="T:System.Threading.SynchronizationContext"/> to manage logging. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.QboCmdlet"> <summary> Base functionality for all qbo4.Infrastructure.Powershell cmdlets. </summary> <seealso cref="!:https://github.com/felixfbecker/PSKubectl/blob/d0f06d896c3d06c4bd2d51798079efb7ab350aae/src/AsyncCmdlet.cs"/> </member> <member name="P:qbo4.Infrastructure.Powershell.QboCmdlet.Configuration"> <summary> Configuration section for QboCmdlets. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.QboCmdlet.LoadConfig(System.String,System.String)"> <summary> Loads configuration from appsettings.json, user secrets, and environment variables. </summary> <param name="configFilePath">Path to a json configuration file for IConfiguration. Defaults to appsettings.json</param> <param name="project">Name of <see cref="P:qbo4.Configuration.Settings.ProjectOptions.Project"/> to use. Defaults to qbo4.Infrastructure.</param> <returns></returns> </member> <member name="P:qbo4.Infrastructure.Powershell.QboCmdlet.Services"> <summary> <see cref="T:System.IServiceProvider"/> for dependency injection. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.QboCmdlet.WriteException(System.Exception,System.String,System.Management.Automation.ErrorCategory,System.Boolean)"> <summary> Writes an exception, optionally with inner exceptions as warnings. </summary> <param name="ex">Exception to write.</param> <param name="errorId">ErrorId to use; defaults to 'QboCmdletError'</param> <param name="category">ErrorCategory to use, defaults to <see cref="F:System.Management.Automation.ErrorCategory.FromStdErr"/>.</param> <param name="includeInnerDetail">If true, inner exception detail will be written as warnings.</param> </member> <member name="M:qbo4.Infrastructure.Powershell.QboCmdlet.Prompt(System.String)"> <summary> Prompt user for a value. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.QboCmdlet.PromptSecure(System.String)"> <summary> Prompts for a value using SecureString. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.QboCmdlet.EnsureConfig(System.String,System.String)"> <summary> Prompts for a configuration value if key is null. </summary> <param name="key">Configuration key to check for.</param> <param name="prompt">Prompt to display to the user.</param> </member> <member name="T:qbo4.Infrastructure.Powershell.SingleThreadSynchronizationContext"> <summary>Provides a SynchronizationContext that's single-threaded.</summary> </member> <member name="F:qbo4.Infrastructure.Powershell.SingleThreadSynchronizationContext._queue"> <summary> Queue of work items. </summary> </member> <member name="F:qbo4.Infrastructure.Powershell.SingleThreadSynchronizationContext._thread"> <summary> Processing thread. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.SingleThreadSynchronizationContext.Post(System.Threading.SendOrPostCallback,System.Object)"> <summary>Dispatches an asynchronous message to the synchronization context.</summary> <param name="callback">The System.Threading.SendOrPostCallback delegate to call.</param> <param name="state">The object passed to the delegate.</param> </member> <member name="M:qbo4.Infrastructure.Powershell.SingleThreadSynchronizationContext.Send(System.Threading.SendOrPostCallback,System.Object)"> <summary>Not supported.</summary> </member> <member name="M:qbo4.Infrastructure.Powershell.SingleThreadSynchronizationContext.RunOnCurrentThread"> <summary>Runs an loop to process all queued work items.</summary> </member> <member name="M:qbo4.Infrastructure.Powershell.SingleThreadSynchronizationContext.Complete"> <summary>Notifies the context that no more work will arrive.</summary> </member> <member name="T:qbo4.Infrastructure.Powershell.WebsiteCmdlet"> <summary> Base cmdlet for <see cref="T:qbo4.Infrastructure.Web.WebServer"/>. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.SetWebsiteCmdlet"> <summary> Ensures a website exists with the appropriate settings to run QBO. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.RemoveWebsiteCmdlet"> <summary> Removes a website. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.GetWebsitesCmdlet"> <summary> Returns websites configured under IIS. </summary> </member> <member name="T:qbo4.Infrastructure.Powershell.SetConnectionCmdlet"> <summary> <para type="synopsis">Adds or updates a connection string in the web.config file of an existing site.</para> <para type="description">A web.config file must be present under the website.</para> <para type="link" uri="https://dev.azure.com/quandisopensource/Documentation/_wiki/wikis/Documentation.wiki/213/Installation-Guide">QBO Installation Guide.</para> </summary> <example> <code>set-qboConnection "Default Web Site" "qbo.Default" "Server=localhost;Database=qbo;TrustedConnection=true" -Validate</code> </example> </member> <member name="P:qbo4.Infrastructure.Powershell.SetConnectionCmdlet.SiteName"> <summary> Website name to add or update connection string to. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.SetConnectionCmdlet.Name"> <summary> Connection string name. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.SetConnectionCmdlet.Value"> <summary> Connection string values. </summary> <example>Server=localhost;Database=CanAddConnectionStrings;TrustedConnection=true</example> </member> <member name="P:qbo4.Infrastructure.Powershell.SetConnectionCmdlet.Provider"> <summary> Provider name. </summary> <example>System.Data.SqlClient</example> </member> <member name="P:qbo4.Infrastructure.Powershell.SetConnectionCmdlet.Validate"> <summary> If true, attempt to open a connection using the connection string. Only use this if using Sql Authentication. Trusted or SSPI connections will run under the IIS AppPool, not your powershell user account. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.SetConnectionCmdlet.ProcessRecordAsync"> <summary> Process record. </summary> <returns></returns> </member> <member name="T:qbo4.Infrastructure.Powershell.GetConnectionCmdlet"> <summary> <para type="synopsis">Gets a connection string in the web.config file of an existing site.</para> <para type="description">A web.config file must be present under the website.</para> <para type="link" uri="https://dev.azure.com/quandisopensource/Documentation/_wiki/wikis/Documentation.wiki/213/Installation-Guide">QBO Installation Guide.</para> </summary> <example> <code>set-qboConnection "Default Web Site" "qbo.Default"</code> </example> </member> <member name="P:qbo4.Infrastructure.Powershell.GetConnectionCmdlet.SiteName"> <summary> Website name to add or update connection string to. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.GetConnectionCmdlet.Name"> <summary> Connection string name. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.GetConnectionCmdlet.ProcessRecordAsync"> <summary> Process record. </summary> <returns></returns> </member> <member name="T:qbo4.Infrastructure.Powershell.GetConnectionsCmdlet"> <summary> <para type="synopsis">Gets connection strings from a website's config file.</para> <para type="description">A web.config file must be present under the website.</para> <para type="link" uri="https://dev.azure.com/quandisopensource/Documentation/_wiki/wikis/Documentation.wiki/213/Installation-Guide">QBO Installation Guide.</para> </summary> <example> <code>get-qboConnections "Default Web Site"</code> </example> </member> <member name="P:qbo4.Infrastructure.Powershell.GetConnectionsCmdlet.SiteName"> <summary> Website name to add or update connection string to. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.GetConnectionsCmdlet.ProcessRecordAsync"> <summary> Process record. </summary> <returns></returns> </member> <member name="T:qbo4.Infrastructure.Powershell.SetApplicationSettingCmdlet"> <summary> <para type="synopsis">Overrides an application setting in the web.config file of an existing site.</para> <para type="description">A web.config file must be present under the website.</para> <para type="link" uri="https://dev.azure.com/quandisopensource/Documentation/_wiki/wikis/Documentation.wiki/213/Installation-Guide">QBO Installation Guide.</para> </summary> <example> <code>set-qboSetting "BaseURL" "https://mysite.localhost.net"</code> </example> </member> <member name="P:qbo4.Infrastructure.Powershell.SetApplicationSettingCmdlet.SiteName"> <summary> Website name to add or update connection string to. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.SetApplicationSettingCmdlet.Name"> <summary> Application setting name </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.SetApplicationSettingCmdlet.Value"> <summary> Application setting value. </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.SetApplicationSettingCmdlet.ProcessRecordAsync"> <summary> Process record. </summary> <returns></returns> </member> <member name="T:qbo4.Infrastructure.Powershell.GetApplicationSettingCmdlet"> <summary> <para type="synopsis">Overrides an application setting in the web.config file of an existing site.</para> <para type="description">A web.config file must be present under the website.</para> <para type="link" uri="https://dev.azure.com/quandisopensource/Documentation/_wiki/wikis/Documentation.wiki/213/Installation-Guide">QBO Installation Guide.</para> </summary> <example> <code>set-qboSetting "BaseURL" "https://mysite.localhost.net"</code> </example> </member> <member name="P:qbo4.Infrastructure.Powershell.GetApplicationSettingCmdlet.SiteName"> <summary> Website name to add or update connection string to. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.GetApplicationSettingCmdlet.Name"> <summary> Application setting name </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.GetApplicationSettingCmdlet.ProcessRecordAsync"> <summary> Process record. </summary> <returns></returns> </member> <member name="T:qbo4.Infrastructure.Powershell.FindApplicationSettingCmdlet"> <summary> <para type="synopsis">Overrides an application setting in the web.config file of an existing site.</para> <para type="description">A web.config file must be present under the website.</para> <para type="link" uri="https://dev.azure.com/quandisopensource/Documentation/_wiki/wikis/Documentation.wiki/213/Installation-Guide">QBO Installation Guide.</para> </summary> <example> <code>set-qboSetting "BaseURL" "https://mysite.localhost.net"</code> </example> </member> <member name="P:qbo4.Infrastructure.Powershell.FindApplicationSettingCmdlet.SiteName"> <summary> Website name to add or update connection string to. </summary> </member> <member name="P:qbo4.Infrastructure.Powershell.FindApplicationSettingCmdlet.Name"> <summary> Application setting name </summary> </member> <member name="M:qbo4.Infrastructure.Powershell.FindApplicationSettingCmdlet.ProcessRecordAsync"> <summary> Process record. </summary> <returns></returns> </member> </members> </doc> |