Quantum.DMS.PowerShell.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Quantum.DMS.PowerShell</name> </assembly> <members> <member name="T:Quantum.DMS.PowerShell.BaseGetCmdLet`1"> <summary> A base class for Get cmdlets covering the common functionality for all get requests. </summary> <typeparam name="TResult">The type of object to deserialize the result to.</typeparam> </member> <member name="M:Quantum.DMS.PowerShell.BaseGetCmdLet`1.#ctor(System.String)"> <summary> Creates an instance of the <see cref="T:Quantum.DMS.PowerShell.BaseGetCmdLet`1"/> class. </summary> <param name="apiUrl">The API URL to connect to.</param> </member> <member name="M:Quantum.DMS.PowerShell.BaseGetCmdLet`1.ProcessRecord"> <summary> Calls the GetAsync method of the underlying <see cref="T:Quantum.DMS.PowerShell.QuantumHttpClient"/> class. </summary> <inheritdoc/> </member> <member name="M:Quantum.DMS.PowerShell.BaseGetCmdLet`1.EndProcessing"> <summary> Outputs <typeparamref name="TResult"/>, or an error if it is null. </summary> <inheritdoc/> </member> <member name="T:Quantum.DMS.PowerShell.BasePostCmdLet`2"> <summary> A base class for Get cmdlets covering the common functionality for all get requests. </summary> <typeparam name="TResult">The type of object to deserialize the result to.</typeparam> <typeparam name="TPostData">The object type of the data sent to the API.</typeparam> </member> <member name="F:Quantum.DMS.PowerShell.BasePostCmdLet`2._apiUrl"> <summary> The URL of the Administrative API. </summary> </member> <member name="P:Quantum.DMS.PowerShell.BasePostCmdLet`2.InputData"> <summary> The data to send to the API as part of the POST request. </summary> </member> <member name="M:Quantum.DMS.PowerShell.BasePostCmdLet`2.#ctor(System.String)"> <summary> Creates an instance of the <see cref="T:Quantum.DMS.PowerShell.BasePostCmdLet`2"/> class. </summary> <param name="apiUrl">The API URL to connect to.</param> </member> <member name="M:Quantum.DMS.PowerShell.BasePostCmdLet`2.ProcessRecord"> <summary> Calls the GetAsync method of the underlying <see cref="T:Quantum.DMS.PowerShell.QuantumHttpClient"/> class. </summary> <inheritdoc/> </member> <member name="M:Quantum.DMS.PowerShell.BasePostCmdLet`2.EndProcessing"> <summary> Outputs <typeparamref name="TResult"/>, or an error if it is null. </summary> <inheritdoc/> </member> <member name="T:Quantum.DMS.PowerShell.BasePostCmdLet`1"> <summary> A base class for Get cmdlets covering the common functionality for all get requests. </summary> <typeparam name="TResult">The type of object to deserialize the result to.</typeparam> </member> <member name="M:Quantum.DMS.PowerShell.BasePostCmdLet`1.#ctor(System.String)"> <summary> Creates an instance of the <see cref="T:Quantum.DMS.PowerShell.BasePostCmdLet`2"/> class. </summary> <param name="apiUrl">The API URL to connect to.</param> </member> <member name="T:Quantum.DMS.PowerShell.Connect.QuantumAccount"> <summary> <para type="synopsis">Connects to a Quantum Administration Server.</para> <para type="description">Use this script to establish a connection to a Quantum Application Server.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Connect.QuantumAccount.AdministrationServerUrl"> <summary> <para type="description">The Application Server URL and Port.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Connect.QuantumAccount.TenantId"> <summary> <para type="description">The tenant identifier to set as the active tenant.</para> </summary> </member> <member name="M:Quantum.DMS.PowerShell.Connect.QuantumAccount.ProcessRecord"> <inheritdoc/> </member> <member name="M:Quantum.DMS.PowerShell.Connect.QuantumAccount.EndProcessing"> <inheritdoc/> </member> <member name="M:Quantum.DMS.PowerShell.Connect.QuantumAccount.RequiresTenantConnection"> <inheritdoc/> </member> <member name="T:Quantum.DMS.PowerShell.Get.MigrationDetails"> <summary> <para type="synopsis">Gets all migrations that are deployed to an environment.</para> <para type="description">Use this script to get all migrations for an environment.</para> </summary> </member> <member name="M:Quantum.DMS.PowerShell.Get.MigrationDetails.#ctor"> <summary> Creates an instance of the <see cref="T:Quantum.DMS.PowerShell.Get.MigrationDetails"/> class. </summary> </member> <member name="M:Quantum.DMS.PowerShell.Get.MigrationDetails.RequiresTenantConnection"> <inheritdoc/> </member> <member name="T:Quantum.DMS.PowerShell.Get.QuantumAdministrativeRoles"> <summary> <para type="synopsis">Gets all Administrative Roles in the environment.</para> <para type="description">Use this script to get the Administrative Roles for an environment.</para> </summary> </member> <member name="T:Quantum.DMS.PowerShell.Get.Tenants"> <summary> <para type="synopsis">Gets all tenants that can be accessed by the current authentication context.</para> <para type="description">Use this script to get all teants for which the current authentication context has access to.</para> </summary> </member> <member name="M:Quantum.DMS.PowerShell.Get.Tenants.#ctor"> <summary> Creates an instance of the <see cref="T:Quantum.DMS.PowerShell.Get.Tenants"/> class. </summary> </member> <member name="M:Quantum.DMS.PowerShell.Get.Tenants.RequiresTenantConnection"> <inheritdoc/> </member> <member name="T:Quantum.DMS.PowerShell.Initialize.QuantumEnvironment"> <summary> <para type="synopsis">Initializes a new Quantum environment.</para> <para type="description">Use this script to create a Quantum environment.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Initialize.QuantumEnvironment.MongoDbConnectionString"> <summary> <para type="description">The MongoDB connection string (without the database name).</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Initialize.QuantumEnvironment.CatalogDatabaseName"> <summary> <para type="description">The name of the catalog database for the new environment.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Initialize.QuantumEnvironment.AdministrativeUser"> <summary> <para type="description">The user account of the initial administrative user. Defaults to the current user.</para> </summary> </member> <member name="M:Quantum.DMS.PowerShell.Initialize.QuantumEnvironment.ProcessRecord"> <inheritdoc/> </member> <member name="T:Quantum.DMS.PowerShell.Install.QuantumService"> <summary> <para type="synopsis">Installs a Quantum service.</para> <para type="description">Use this script to Installs a Quantum service.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Install.QuantumService.ServiceType"> <summary> <para type="description">The service to start.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Install.QuantumService.ComputerName"> <summary> <para type="description">The computer name of the machine hosting the service.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Install.QuantumService.ExecutablePath"> <summary> <para type="description">The path to the executable of the service on the target computer.</para> </summary> </member> <member name="M:Quantum.DMS.PowerShell.Install.QuantumService.ProcessRecord"> <inheritdoc/> </member> <member name="T:Quantum.DMS.PowerShell.Invoke.QuantumDatabaseMigration"> <summary> A class for a cmdlet responsible for initiating database migrations. </summary> </member> <member name="P:Quantum.DMS.PowerShell.Invoke.QuantumDatabaseMigration.DatabaseName"> <summary> <para type="description">The name of the database to migrate.</para> </summary> </member> <member name="M:Quantum.DMS.PowerShell.Invoke.QuantumDatabaseMigration.#ctor"> <summary> Creates an instance of the <see cref="T:Quantum.DMS.PowerShell.Invoke.QuantumDatabaseMigration"/> class. </summary> </member> <member name="M:Quantum.DMS.PowerShell.Invoke.QuantumDatabaseMigration.ProcessRecord"> <inheritdoc/> </member> <member name="M:Quantum.DMS.PowerShell.Invoke.QuantumDatabaseMigration.RequiresTenantConnection"> <inheritdoc/> </member> <member name="T:Quantum.DMS.PowerShell.New.QuantumAdministrativeUser"> <summary> <para type="synopsis">Creates a new Quantum Administrative User.</para> <para type="description">Use this script to create a new Administrative User in the environment.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.New.QuantumAdministrativeUser.Username"> <summary> <para type="description">The username of the Administrative User.</para> </summary> </member> <member name="M:Quantum.DMS.PowerShell.New.QuantumAdministrativeUser.#ctor"> <summary> Creates an instance of the <see cref="T:Quantum.DMS.PowerShell.New.QuantumAdministrativeUser"/> class. </summary> </member> <member name="M:Quantum.DMS.PowerShell.New.QuantumAdministrativeUser.ProcessRecord"> <inheritdoc/> </member> <member name="M:Quantum.DMS.PowerShell.New.QuantumAdministrativeUser.RequiresTenantConnection"> <inheritdoc/> </member> <member name="T:Quantum.DMS.PowerShell.New.QuantumTenant"> <summary> <para type="synopsis">Creates a new tenant in a Quantum environment.</para> <para type="description">Use this script to create a new tenant in the environment.</para> </summary> </member> <member name="M:Quantum.DMS.PowerShell.New.QuantumTenant.#ctor"> <summary> </summary> </member> <member name="M:Quantum.DMS.PowerShell.New.QuantumTenant.RequiresTenantConnection"> <inheritdoc/> </member> <member name="T:Quantum.DMS.PowerShell.Nothing"> <summary> A class rerpesenting a void return type. </summary> </member> <member name="P:Quantum.DMS.PowerShell.Nothing.Instance"> <summary> Creates an instance of the <see cref="T:Quantum.DMS.PowerShell.Nothing"/> class. </summary> </member> <member name="T:Quantum.DMS.PowerShell.QuantumCmdLet`1"> <summary> A class for a Quantum CmdLet. </summary> <typeparam name="TResult">The type of object to return from the cmdlet execution.</typeparam> </member> <member name="P:Quantum.DMS.PowerShell.QuantumCmdLet`1.RequiresAdmininstratorPrivileges"> <summary> A boolean value set to true if the cmdlet requires administrator privileges. </summary> </member> <member name="P:Quantum.DMS.PowerShell.QuantumCmdLet`1.OutputResult"> <summary> The result to be outputed to the PowerShell console when the cmdlet is complete. </summary> </member> <member name="F:Quantum.DMS.PowerShell.QuantumCmdLet`1.CancellationTokenSource"> <summary> A cancellation token source to manage cancellation activities for async operations. </summary> </member> <member name="F:Quantum.DMS.PowerShell.QuantumCmdLet`1.Token"> <summary> A <see cref="T:System.Threading.CancellationToken"/> retrieved from the current <see cref="F:Quantum.DMS.PowerShell.QuantumCmdLet`1.CancellationTokenSource"/> . </summary> </member> <member name="M:Quantum.DMS.PowerShell.QuantumCmdLet`1.#ctor"> <summary> Creates an instance of the <see cref="!:QuantumCmdLet"/> class. </summary> </member> <member name="M:Quantum.DMS.PowerShell.QuantumCmdLet`1.StopProcessing"> <summary> Called when the PowerShell process receives a termination request. </summary> </member> <member name="M:Quantum.DMS.PowerShell.QuantumCmdLet`1.OutputOperationResultError(OneBitSoftware.Utilities.OperationResult)"> <summary> Outputs an <see cref="T:OneBitSoftware.Utilities.OperationResult"/> to the PowerShell console. If the operation result is successfull, this method will output as an object. If the operation result is unsuccessfull, this method will output each error. </summary> </member> <member name="M:Quantum.DMS.PowerShell.QuantumCmdLet`1.RunWithErrorHandling(System.Action)"> <summary> Calls a passed action asynchronously. </summary> <param name="function">The function to execute.</param> </member> <member name="M:Quantum.DMS.PowerShell.QuantumCmdLet`1.EndProcessing"> <summary> Outputs <typeparamref name="TResult"/>, or nothing if it is null. </summary> <inheritdoc/> </member> <member name="T:Quantum.DMS.PowerShell.QuantumConnection"> <summary> A class for connection details to a Quantum infrastructure. </summary> </member> <member name="P:Quantum.DMS.PowerShell.QuantumConnection.AdministrationServerUrl"> <summary> The Administration Server URL, including the port. </summary> </member> <member name="P:Quantum.DMS.PowerShell.QuantumConnection.TenantId"> <summary> The a tenant ID for specific calls to a particular tenant. </summary> </member> <member name="P:Quantum.DMS.PowerShell.QuantumConnection.Client"> <summary> The <see cref="T:Quantum.DMS.PowerShell.QuantumHttpClient"/> responsible for all API communication. </summary> </member> <member name="P:Quantum.DMS.PowerShell.QuantumConnection.Current"> <summary> The current instance of the Quantum connection. </summary> </member> <member name="M:Quantum.DMS.PowerShell.QuantumConnection.#ctor(System.String,System.String)"> <summary> Creates an instance of the <see cref="T:Quantum.DMS.PowerShell.QuantumConnection"/> class. </summary> <param name="administrationServerUrl">The Administration Server URL, including the port.</param> <param name="tenantId">The tenant identifier.</param> <exception cref="T:System.ApplicationException"></exception> </member> <member name="M:Quantum.DMS.PowerShell.QuantumConnection.ValidateConnectionAsync(System.Threading.CancellationToken)"> <summary> Validates that the Application Server API can be contacted. </summary> <param name="cancellationToken"></param> <returns>A task representing the asynchronous operation.</returns> </member> <member name="T:Quantum.DMS.PowerShell.QuantumHttpClient"> <summary> A class for HTTP connections to an Administration Server API. </summary> </member> <member name="M:Quantum.DMS.PowerShell.QuantumHttpClient.#ctor(System.String,System.String)"> <summary> Creates an instance of the <see cref="T:Quantum.DMS.PowerShell.QuantumHttpClient"/> class. </summary> <param name="baseApiAddress"></param> <param name="tenantId"></param> <exception cref="T:System.ArgumentException"></exception> </member> <member name="M:Quantum.DMS.PowerShell.QuantumHttpClient.GetAsync(System.String,System.Threading.CancellationToken)"> <summary> Executes an HTTP Get method against the passed <paramref name="requestUri"/>. </summary> <param name="requestUri"></param> <param name="cancellationToken">A cancellation token fot the asynchronous web request.</param> <returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the resulting <see cref="T:System.Net.Http.HttpResponseMessage"/> object result.</returns> </member> <member name="M:Quantum.DMS.PowerShell.QuantumHttpClient.GetAsync``1(System.String,System.Threading.CancellationToken)"> <summary> Executes an HTTP Get method against the passed <paramref name="requestUri"/>. </summary> <param name="requestUri"></param> <param name="cancellationToken">A cancellation token fot the asynchronous web request.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing the resulting object result.</returns> </member> <member name="M:Quantum.DMS.PowerShell.QuantumHttpClient.PostAsync``1(System.String,System.Threading.CancellationToken)"> <summary> Executes an HTTP POST method against the passed <paramref name="requestUri"/>. </summary> <param name="requestUri"></param> <param name="data"></param> <param name="cancellationToken">A cancellation token fot the asynchronous web request.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing the resulting object result.</returns> </member> <member name="M:Quantum.DMS.PowerShell.QuantumHttpClient.PostAsync``2(System.String,``1,System.Threading.CancellationToken)"> <summary> Executes an HTTP POST method against the passed <paramref name="requestUri"/>. </summary> <param name="requestUri"></param> <param name="data"></param> <param name="cancellationToken">A cancellation token fot the asynchronous web request.</param> <returns>A <see cref="T:System.Threading.Tasks.Task`1"/> representing the resulting object result.</returns> </member> <member name="M:Quantum.DMS.PowerShell.QuantumHttpClient.ValidateConnectionAsync(System.Threading.CancellationToken)"> <summary> Calls the API Heartbeat endpoint to ensure that the connection can be successful. </summary> <param name="cancellationToken">A cancellation token fot the asynchronous web request.</param> <returns>A task representing the asynchronous request.</returns> <exception cref="T:System.Net.Http.HttpRequestException">When there is no connection to the Heartbeat API.</exception> </member> <member name="T:Quantum.DMS.PowerShell.QuantumSessionCmdLet`1"> <summary> A base class for a CmdLet with access to session data. </summary> <typeparam name="TResult">The type of object to return from the cmdlet execution.</typeparam> </member> <member name="P:Quantum.DMS.PowerShell.QuantumSessionCmdLet`1.Client"> <summary> An instance of the <see cref="T:Quantum.DMS.PowerShell.QuantumHttpClient"/> for access to the Application Server API. </summary> </member> <member name="M:Quantum.DMS.PowerShell.QuantumSessionCmdLet`1.ProcessRecord"> <inheritdoc/> </member> <member name="M:Quantum.DMS.PowerShell.QuantumSessionCmdLet`1.RequiresTenantConnection"> <summary> Defines if the cmdlet requires a connection with a specific tenant ID. </summary> <returns>True, if the cmdlet requires a connection with a specific tenant ID, otherwise false.</returns> </member> <member name="T:Quantum.DMS.PowerShell.Start.QuantumSearchFullCrawl"> <summary> A class for a cmdlet responsible for initiating a full search crawl. </summary> </member> <member name="M:Quantum.DMS.PowerShell.Start.QuantumSearchFullCrawl.#ctor"> <summary> Creates an instance of the <see cref="T:Quantum.DMS.PowerShell.Start.QuantumSearchFullCrawl"/> class. </summary> </member> <member name="M:Quantum.DMS.PowerShell.Start.QuantumSearchFullCrawl.RequiresTenantConnection"> <inheritdoc/> </member> <member name="T:Quantum.DMS.PowerShell.Start.QuantumService"> <summary> <para type="synopsis">Starts a Quantum service.</para> <para type="description">Use this script to start a Quantum service.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Start.QuantumService.ServiceType"> <summary> <para type="description">The service to start.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Start.QuantumService.ComputerName"> <summary> <para type="description">The computer name of the machine hosting the service.</para> </summary> </member> <member name="M:Quantum.DMS.PowerShell.Start.QuantumService.ProcessRecord"> <inheritdoc/> </member> <member name="T:Quantum.DMS.PowerShell.Stop.QuantumService"> <summary> <para type="synopsis">Stops a Quantum service.</para> <para type="description">Use this script to stop a Quantum service.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Stop.QuantumService.ServiceType"> <summary> <para type="description">The service to start.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Stop.QuantumService.ComputerName"> <summary> <para type="description">The computer name of the machine hosting the service.</para> </summary> </member> <member name="M:Quantum.DMS.PowerShell.Stop.QuantumService.ProcessRecord"> <inheritdoc/> </member> <member name="T:Quantum.DMS.PowerShell.Uninstall.QuantumService"> <summary> <para type="synopsis">Installs a Quantum service.</para> <para type="description">Use this script to Installs a Quantum service.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Uninstall.QuantumService.ServiceType"> <summary> <para type="description">The service to start.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Uninstall.QuantumService.ComputerName"> <summary> <para type="description">The computer name of the machine hosting the service.</para> </summary> </member> <member name="M:Quantum.DMS.PowerShell.Uninstall.QuantumService.ProcessRecord"> <inheritdoc/> </member> </members> </doc> |