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="P:Quantum.DMS.PowerShell.BaseGetCmdLet`1.ApiUrl"> <summary> The URL of the Administrative API. </summary> </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`3"> <summary> A base class for Get cmdlets covering the common functionality for all get requests. </summary> <typeparam name="TOutput">The type of object to be outputted by the cmdlet.</typeparam> <typeparam name="TResult">The type of object to deserialize the POST request result to.</typeparam> <typeparam name="TPostData">The object type of the data sent to the API.</typeparam> </member> <member name="P:Quantum.DMS.PowerShell.BasePostCmdLet`3.InputData"> <summary> The data to send to the API as part of the POST request. </summary> </member> <member name="P:Quantum.DMS.PowerShell.BasePostCmdLet`3.ApiUrl"> <summary> The URL of the Administrative API. </summary> </member> <member name="M:Quantum.DMS.PowerShell.BasePostCmdLet`3.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`3.MapResponseToOutput(`1)"> <summary> Map <typeparamref name="TResult"/> to <typeparamref name="TOutput"/>. </summary> </member> <member name="M:Quantum.DMS.PowerShell.BasePostCmdLet`3.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="TOutput">The type of object to be outputted by the cmdlet.</typeparam> <typeparam name="TResult">The type of object to deserialize the result to.</typeparam> </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.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.QuantumDatabaseMigrationDetails"> <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="P:Quantum.DMS.PowerShell.Get.QuantumDatabaseMigrationDetails.DatabaseServerUrl"> <summary> <para type="description">The connection string to the database server.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Get.QuantumDatabaseMigrationDetails.DatabaseSet"> <summary> <para type="description">The unique identifier of the database set.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Get.QuantumDatabaseMigrationDetails.ApiUrl"> <inheritdoc/> </member> <member name="M:Quantum.DMS.PowerShell.Get.QuantumDatabaseMigrationDetails.RequiresTenantConnection"> <inheritdoc/> </member> <member name="T:Quantum.DMS.PowerShell.Get.QuantumDatabaseSetBackups"> <summary> <para type="synopsis">Gets information about all backups in the environment.</para> <para type="description">Use this script to get information about all backups for an environment.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Get.QuantumDatabaseSetBackups.ApiUrl"> <inheritdoc /> </member> <member name="M:Quantum.DMS.PowerShell.Get.QuantumDatabaseSetBackups.RequiresTenantConnection"> <inheritdoc /> </member> <member name="T:Quantum.DMS.PowerShell.Get.QuantumPackages"> <summary> <para type="synopsis">Gets all Packages at the tenant level in the environment.</para> <para type="description">Use this script to get the Packages at tenant level for an environment.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Get.QuantumPackages.ApiUrl"> <inheritdoc/> </member> <member name="M:Quantum.DMS.PowerShell.Get.QuantumPackages.ProcessRecord"> <inheritdoc /> </member> <member name="M:Quantum.DMS.PowerShell.Get.QuantumPackages.MapResponseToOutput(System.Collections.Generic.IEnumerable{Quantum.PowerShell.Models.Get.GetPackages.GetPackageResponseModel})"> <inheritdoc /> </member> <member name="M:Quantum.DMS.PowerShell.Get.QuantumPackages.RequiresTenantConnection"> <inheritdoc /> </member> <member name="T:Quantum.DMS.PowerShell.Get.QuantumService"> <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="P:Quantum.DMS.PowerShell.Get.QuantumService.ServiceType"> <summary> <para type="description">The service to start.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Get.QuantumService.ComputerName"> <summary> <para type="description">The computer name of the machine hosting the service.</para> </summary> </member> <member name="M:Quantum.DMS.PowerShell.Get.QuantumService.ProcessRecord"> <inheritdoc/> </member> <member name="T:Quantum.DMS.PowerShell.Get.QuantumTenants"> <summary> <para type="synopsis">Gets all tenants that can be accessed by the current user connection.</para> <para type="description">Use this script to get all tenants for which the current user connection has access to.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Get.QuantumTenants.ApiUrl"> <inheritdoc/> </member> <member name="M:Quantum.DMS.PowerShell.Get.QuantumTenants.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.DatabasePrefix"> <summary> <para type="description">The database set prefix 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.DatabaseServerUrl"> <summary> <para type="description">The connection string to the database server to migrate.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Invoke.QuantumDatabaseMigration.DatabaseSet"> <summary> <para type="description">The unique identifier of the database set to migrate.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Invoke.QuantumDatabaseMigration.Mode"> <summary> <para type="description">The mode that should be used for applying all pending migrations.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Invoke.QuantumDatabaseMigration.ApiUrl"> <inheritdoc/> </member> <member name="M:Quantum.DMS.PowerShell.Invoke.QuantumDatabaseMigration.ProcessRecord"> <inheritdoc/> </member> <member name="M:Quantum.DMS.PowerShell.Invoke.QuantumDatabaseMigration.MapResponseToOutput(Quantum.PowerShell.Models.Invoke.InvokeMigrationResponseModel)"> <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="P:Quantum.DMS.PowerShell.New.QuantumAdministrativeUser.ApiUrl"> <inheritdoc/> </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.QuantumDatabaseSet"> <summary> <para type="synopsis">Creates a new Quantum database set, including the required databases and collections.</para> <para type="description">Use this script to create a new database set in the environment.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.New.QuantumDatabaseSet.MongoDbConnectionString"> <summary> <para type="description">The MongoDB connection string (without the database name).</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.New.QuantumDatabaseSet.DatabaseSetPrefix"> <summary> <para type="description">The database set prefix that will be prepend in every required database name for the new environment.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.New.QuantumDatabaseSet.Creator"> <summary> <para type="description">The user that is creating the database set.</para> </summary> </member> <member name="M:Quantum.DMS.PowerShell.New.QuantumDatabaseSet.ProcessRecord"> <inheritdoc/> </member> <member name="T:Quantum.DMS.PowerShell.New.QuantumDatabaseSetBackup"> <summary> <para type="synopsis">Creates a new backup in a Quantum environment.</para> <para type="description">Use this script to create a new backup in the environment.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.New.QuantumDatabaseSetBackup.ApiUrl"> <inheritdoc /> </member> <member name="M:Quantum.DMS.PowerShell.New.QuantumDatabaseSetBackup.ProcessRecord"> <inheritdoc /> </member> <member name="M:Quantum.DMS.PowerShell.New.QuantumDatabaseSetBackup.RequiresTenantConnection"> <inheritdoc /> </member> <member name="T:Quantum.DMS.PowerShell.New.QuantumPackage"> <summary> <para type="synopsis">Creates a new package in a Quantum environment.</para> <para type="description">Use this script to create a new package in the environment.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.New.QuantumPackage.PackageDefinitionPath"> <summary> Gets or sets the path pointing to a JSON file representing the package definition. </summary> </member> <member name="P:Quantum.DMS.PowerShell.New.QuantumPackage.ApiUrl"> <inheritdoc/> </member> <member name="M:Quantum.DMS.PowerShell.New.QuantumPackage.ProcessRecord"> <inheritdoc /> </member> <member name="M:Quantum.DMS.PowerShell.New.QuantumPackage.MapResponseToOutput(Quantum.PowerShell.Models.Util.RawJson)"> <inheritdoc /> </member> <member name="M:Quantum.DMS.PowerShell.New.QuantumPackage.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="P:Quantum.DMS.PowerShell.New.QuantumTenant.Name"> <summary> <para type="description">The name of the tenant.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.New.QuantumTenant.TenantAdministrator"> <summary> <para type="description">TODO.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.New.QuantumTenant.DatabaseServerUrl"> <summary> <para type="description">The connection string to the database server (without the catalog database).</para> </summary> <example>mongodb://servername.domain:27127</example> </member> <member name="P:Quantum.DMS.PowerShell.New.QuantumTenant.DatabaseSet"> <summary> <para type="description">The prefix for all database names.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.New.QuantumTenant.SearchUrl"> <summary> <para type="description">The search url.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.New.QuantumTenant.SearchIndexAlias"> <summary> <para type="description">The search index alias.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.New.QuantumTenant.LdapPath"> <summary> <para type="description">The LDAP path to use during administrator user resolution.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.New.QuantumTenant.FileContentProcessorUrl"> <summary> <para type="description">The name of the tenant.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.New.QuantumTenant.ApiUrl"> <inheritdoc/> </member> <member name="M:Quantum.DMS.PowerShell.New.QuantumTenant.RequiresTenantConnection"> <inheritdoc/> </member> <member name="M:Quantum.DMS.PowerShell.New.QuantumTenant.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.New.QuantumTenant.MapResponseToOutput(Quantum.PowerShell.Models.TenantModel)"> <inheritdoc/> </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``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.Restore.QuantumDatabaseSetBackup"> <summary> <para type="synopsis">Restores the previously backed up databases of a Quantum environment.</para> <para type="description">Use this script to restore the previously backed up data in an environment.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Restore.QuantumDatabaseSetBackup.NameIdentifier"> <summary> Gets or sets the name identifier of the backup that should be restored. </summary> </member> <member name="P:Quantum.DMS.PowerShell.Restore.QuantumDatabaseSetBackup.ApiUrl"> <inheritdoc /> </member> <member name="M:Quantum.DMS.PowerShell.Restore.QuantumDatabaseSetBackup.RequiresTenantConnection"> <inheritdoc /> </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="P:Quantum.DMS.PowerShell.Start.QuantumSearchFullCrawl.ApiUrl"> <inheritdoc/> </member> <member name="M:Quantum.DMS.PowerShell.Start.QuantumSearchFullCrawl.RequiresTenantConnection"> <inheritdoc/> </member> <member name="M:Quantum.DMS.PowerShell.Start.QuantumSearchFullCrawl.MapResponseToOutput(Quantum.PowerShell.Models.Post.Search.StartFullCrawlResponseModel)"> <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> <member name="T:Quantum.DMS.PowerShell.Update.QuantumPackage"> <summary> <para type="synopsis">Updates a new package in a Quantum environment.</para> <para type="description">Use this script to update an existing package in the environment.</para> </summary> </member> <member name="P:Quantum.DMS.PowerShell.Update.QuantumPackage.PackageId"> <summary> Gets or sets the unique identifier of the package that should be updated. </summary> </member> <member name="P:Quantum.DMS.PowerShell.Update.QuantumPackage.VersionDefinitionPath"> <summary> Gets or sets the path pointing to a JSON file representing the new version definition. </summary> </member> <member name="P:Quantum.DMS.PowerShell.Update.QuantumPackage.ApiUrl"> <inheritdoc/> </member> <member name="M:Quantum.DMS.PowerShell.Update.QuantumPackage.ProcessRecord"> <inheritdoc /> </member> <member name="M:Quantum.DMS.PowerShell.Update.QuantumPackage.MapResponseToOutput(Quantum.PowerShell.Models.Util.RawJson)"> <inheritdoc /> </member> <member name="M:Quantum.DMS.PowerShell.Update.QuantumPackage.RequiresTenantConnection"> <inheritdoc /> </member> <member name="T:Quantum.DMS.PowerShell.Utilities.CmdletExtensions"> <summary> A class containing some extension methods that can be used to simplify common processes when working with cmdlets. </summary> </member> <member name="M:Quantum.DMS.PowerShell.Utilities.CmdletExtensions.TryReadRawJson(System.Management.Automation.Cmdlet,System.String,System.Nullable{Quantum.PowerShell.Models.Util.RawJson}@)"> <summary> Use this method to read safely a raw json string from a file. </summary> <param name="cmdlet">The <see cref="T:System.Management.Automation.Cmdlet"/> to extend.</param> <param name="path">The path to the JSON file the content of which should be read.</param> <param name="rawJson">An out parameter where will be stored the read JSON text.</param> <returns>Returns true if the text was successfully read. Else, returns false.</returns> </member> <member name="T:Quantum.DMS.PowerShell.Utilities.ProblemDetails"> <summary> A machine-readable format for specifying errors in HTTP API responses based on <see href="https://tools.ietf.org/html/rfc7807"/>. </summary> </member> <member name="P:Quantum.DMS.PowerShell.Utilities.ProblemDetails.Type"> <summary> A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank". </summary> </member> <member name="P:Quantum.DMS.PowerShell.Utilities.ProblemDetails.Title"> <summary> A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization(e.g., using proactive content negotiation; see[RFC7231], Section 3.4). </summary> </member> <member name="P:Quantum.DMS.PowerShell.Utilities.ProblemDetails.Status"> <summary> The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. </summary> </member> <member name="P:Quantum.DMS.PowerShell.Utilities.ProblemDetails.Detail"> <summary> A human-readable explanation specific to this occurrence of the problem. </summary> </member> <member name="P:Quantum.DMS.PowerShell.Utilities.ProblemDetails.Instance"> <summary> A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. </summary> </member> <member name="P:Quantum.DMS.PowerShell.Utilities.ProblemDetails.Extensions"> <summary> Gets the <see cref="T:System.Collections.Generic.IDictionary`2"/> for extension members. <para> Problem type definitions MAY extend the problem details object with additional members. Extension members appear in the same namespace as other members of a problem type. </para> </summary> <remarks> The round-tripping behavior for <see cref="P:Quantum.DMS.PowerShell.Utilities.ProblemDetails.Extensions"/> is determined by the implementation of the Input \ Output formatters. In particular, complex types or collection types may not round-trip to the original type when using the built-in JSON or XML formatters. </remarks> </member> </members> </doc> |