desktop/Eryph.ComputeClient.Commands.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Eryph.ComputeClient.Commands</name> </assembly> <members> <member name="F:Eryph.ComputeClient.Commands.Catlets.CatletCmdLet.CatletResourceKind"> <summary>Resource kind used in catlet not-found / ambiguity messages.</summary> </member> <member name="F:Eryph.ComputeClient.Commands.Catlets.CatletCmdLet.EnvironmentAmbiguityHint"> <summary> Hint shown when a catlet name is ambiguous, naming the parameter that disambiguates it (a catlet name is unique only per project + environment). </summary> </member> <member name="M:Eryph.ComputeClient.Commands.Catlets.CatletCmdLet.EnvironmentHintIfUnset(System.String)"> <summary> The <see cref="F:Eryph.ComputeClient.Commands.Catlets.CatletCmdLet.EnvironmentAmbiguityHint"/>, but only when <paramref name="environment"/> was not already supplied. Once -Environment has been applied it did not resolve the ambiguity, so suggesting it again would be misleading; return null in that case. </summary> </member> <member name="M:Eryph.ComputeClient.Commands.Catlets.CatletCmdLet.ListCatlets(System.String,System.String)"> <summary> Lists the catlets of a project, optionally narrowed to a single environment. A catlet's name is unique only per project + environment, so a lookup by name can match several catlets across environments; passing an environment restricts the listing to that environment (case-insensitive exact match). An empty/null environment applies no filter and lists every environment. As the server has no environment filter, this is applied client-side, mirroring Get-VNetwork and Get-CatletDisk. An explicit id (a GUID) bypasses this listing entirely. </summary> </member> <member name="M:Eryph.ComputeClient.Commands.Catlets.CatletConfigCmdlet.PopulateVariables(Eryph.ConfigModel.Catlets.CatletConfig,System.Collections.Hashtable,System.Boolean,System.Boolean)"> <summary> Populates the variables in the given <paramref name="catletConfig"/> by applying the values from the <paramref name="variables"/> hashtable and interactively asking the user for the values. Returns <see langword="false"/> when the user aborted the interactive prompt and <see langword="true"/> otherwise. </summary> </member> <member name="T:Eryph.ComputeClient.Commands.Catlets.CatletGuestServiceGetCmdlet"> <summary> Shared base for the read cmdlets that project the guest-services state of a catlet. The state is not returned directly: <c>GetGuestServices</c> starts an operation whose result carries the agent status, version, provisioning state and the configured shell. This base resolves the target catlet(s), runs the operation and hands the typed result to the derived cmdlet, which decides which part of it to surface (runtime status vs. configuration). </summary> </member> <member name="M:Eryph.ComputeClient.Commands.Catlets.CatletGuestServiceGetCmdlet.WriteResult(Eryph.ComputeClient.Models.Catlet,Eryph.ComputeClient.Models.GuestServicesStatusOperationResult)"> <summary> Projects the part of the guest-services result this cmdlet is responsible for. </summary> </member> <member name="T:Eryph.ComputeClient.Commands.Catlets.GetCatletProvisioningLogCommand"> <summary> Reads the catlet's provisioning log, reassembled from the guest's cloud-init telemetry. The log is not returned directly: <c>GetProvisioningLog</c> starts an operation whose result carries both a rendered, human-readable text log and the structured events. By default the structured events are written to the pipeline as <see cref="T:Eryph.ComputeClient.Commands.Catlets.CatletProvisioningLogEntry"/> objects (each carrying the catlet it belongs to, so output stays correlatable when several catlets are targeted); <c>-AsText</c> emits the rendered text log instead, prefixed with a catlet header. </summary> </member> <member name="P:Eryph.ComputeClient.Commands.Catlets.GetCatletProvisioningLogCommand.AsText"> <summary> Emit the rendered, human-readable text log instead of the structured events. </summary> </member> <member name="T:Eryph.ComputeClient.Commands.Catlets.CatletProvisioningLogEntry"> <summary> A single provisioning-log event, tagged with the catlet it belongs to so the pipeline output can be correlated back to a catlet when several are targeted. </summary> </member> <member name="T:Eryph.ComputeClient.Commands.Catlets.GetCatletProvisioningStatusCommand"> <summary> Reports the catlet's provisioning status. Unlike the guest-services state, the provisioning status is carried directly on the catlet resource, so it is read straight from <c>Get</c>/<c>List</c> without starting an operation. The provisioning status (<see cref="T:Eryph.ComputeClient.Models.CatletProvisioningStatus"/>) reflects the catlet-level provisioning progress and is distinct from the guest agent's own provisioning state surfaced by Get-CatletGuestServiceStatus. </summary> </member> <member name="P:Eryph.ComputeClient.Commands.Catlets.RemoveCatletCommand.Force"> <summary> This parameter overrides the ShouldContinue call to force the cmdlet to stop its operation. This parameter should always be used with caution. </summary> </member> <member name="P:Eryph.ComputeClient.Commands.Catlets.RemoveCatletCommand.PassThru"> <summary> This parameter indicates that the cmdlet should return an object to the pipeline after the processing has been completed. </summary> </member> <member name="P:Eryph.ComputeClient.Commands.Catlets.RemoveCatletDiskCmdlet.Force"> <summary> This parameter overrides the ShouldContinue call to force the cmdlet to stop its operation. This parameter should always be used with caution. </summary> </member> <member name="P:Eryph.ComputeClient.Commands.Catlets.RemoveCatletDiskCmdlet.PassThru"> <summary> This parameter indicates that the cmdlet should return an object to the pipeline after the processing has been completed. </summary> </member> <member name="P:Eryph.ComputeClient.Commands.Catlets.RemoveCatletGuestServiceAccessKeyCommand.PassThru"> <summary> Returns the catlet whose access key was revoked. By default this cmdlet produces no output. </summary> </member> <member name="P:Eryph.ComputeClient.Commands.Catlets.SetCatletGuestServiceConfigCommand.Shell"> <summary> Shell command for interactive SSH sessions. An empty string clears the override; omitting the parameter leaves the current value unchanged. </summary> </member> <member name="P:Eryph.ComputeClient.Commands.Catlets.SetCatletGuestServiceConfigCommand.ShellArgs"> <summary> Arguments for the shell command. Same empty/omitted semantics as <see cref="P:Eryph.ComputeClient.Commands.Catlets.SetCatletGuestServiceConfigCommand.Shell"/>. </summary> </member> <member name="P:Eryph.ComputeClient.Commands.Catlets.StartCatletCommand.Force"> <summary> This parameter overrides the ShouldContinue call to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="P:Eryph.ComputeClient.Commands.Catlets.StopCatletCommand.Force"> <summary> This parameter overrides the ShouldContinue call to force the cmdlet to stop its operation. This parameter should always be used with caution. </summary> </member> <member name="P:Eryph.ComputeClient.Commands.Catlets.SubmitCatletDeployment.TargetEnvironment"> <summary> The environment this deployment targets. Left unset, the server deploys into the default environment, so the conflict check has to compare against the same name. </summary> </member> <member name="M:Eryph.ComputeClient.Commands.ComputeCmdLet.TryGetProjectId(System.String,System.String@)"> <summary> Resolves a project name to its id, turning an unknown/inaccessible project into a non-terminating error (returning false) instead of a terminating exception. A null/empty name yields a null id and true (i.e. "no project filter"). </summary> </member> <member name="M:Eryph.ComputeClient.Commands.ComputeCmdLet.IsResourceId(System.String)"> <summary> Determines whether a positional value should be treated as a resource id rather than a name. Resource ids are GUIDs; a value that parses as a GUID and contains no wildcard characters is an id. As resource names are short, restricted strings they can never collide with the GUID form. </summary> </member> <member name="M:Eryph.ComputeClient.Commands.ComputeCmdLet.ResolveByNameOrId``1(System.String,System.Func{System.String,``0},System.Func{System.Collections.Generic.IEnumerable{``0}},System.Func{``0,System.String},System.String)"> <summary> Resolves a value that may be either a resource id (a GUID) or a name pattern into the matching resources. A GUID is looked up by id; otherwise the listing is filtered by name. Following the convention of cmdlets like Get-Process, an exact name (no wildcards) that matches nothing produces a not-found error, while a wildcard pattern simply yields nothing. Used both to write results (Get-*) and to resolve action targets (Start-/Stop-/Remove-*). </summary> <remarks> This is a deferred iterator that calls <c>WriteError</c> while enumerating, so it must be consumed synchronously on the pipeline thread (a foreach inside ProcessRecord/EndProcessing). Do not capture the result and enumerate it later. </remarks> </member> <member name="M:Eryph.ComputeClient.Commands.ComputeCmdLet.ResolveActionTargets``1(System.String,System.String,System.Func{System.String,``0},System.Func{System.String,System.Collections.Generic.IEnumerable{``0}},System.Func{``0,System.String},System.String,System.String)"> <summary> Resolves the target(s) of a mutating cmdlet from a value that may be a resource id (a GUID) or a name. An id is used directly. An exact name is resolved across every project the caller can access; <paramref name="projectName"/> (and filters such as -Environment) only narrow the search. Because some names are unique only per project + environment, an exact name that resolves to more than one resource is rejected as ambiguous rather than mutated, so a mutation never silently fans out. A wildcard, which matches many by design, still requires <paramref name="projectName"/> so it cannot fan out across projects. </summary> <remarks> Like <see cref="M:Eryph.ComputeClient.Commands.ComputeCmdLet.ResolveByNameOrId``1(System.String,System.Func{System.String,``0},System.Func{System.Collections.Generic.IEnumerable{``0}},System.Func{``0,System.String},System.String)"/> this is a deferred iterator that calls <c>WriteError</c> while enumerating; consume it on the pipeline thread. </remarks> </member> <member name="M:Eryph.ComputeClient.Commands.ComputeCmdLet.FilterByName``1(System.Collections.Generic.IEnumerable{``0},System.String,System.Func{``0,System.String},System.String,System.String)"> <summary> Filters a listing by a name pattern (PowerShell wildcards, case-insensitive). An exact name (no wildcards) that matches nothing produces a not-found error; a wildcard pattern yields nothing; a null/empty pattern yields everything. As eryph has no server-side search, the filtering is performed client-side. </summary> </member> <member name="M:Eryph.ComputeClient.Commands.ComputeCmdLet.WriteByNameOrId``1(System.String,System.Func{System.String,``0},System.Func{System.Collections.Generic.IEnumerable{``0}},System.Func{``0,System.String},System.String,System.Action{``0})"> <summary> Resolves a name-or-id value and writes the matching resources to the pipeline. </summary> </member> <member name="M:Eryph.ComputeClient.Commands.ComputeCmdLet.WriteFilteredByName``1(System.Collections.Generic.IEnumerable{``0},System.String,System.Func{``0,System.String},System.String,System.Action{``0},System.String)"> <summary> Writes the items of a listing to the pipeline, filtered by a name pattern. </summary> </member> <member name="M:Eryph.ComputeClient.Commands.ComputeCmdLet.TryGetById``1(System.String,System.Func{System.String,``0},System.String,``0@)"> <summary> Looks up a resource by id, translating a 404 into a friendly non-terminating not-found error instead of leaking a <see cref="T:Azure.RequestFailedException"/>. </summary> </member> <member name="P:Eryph.ComputeClient.Commands.Operations.StopEryphOperationCommand.Force"> <summary> This parameter overrides the ShouldContinue call to force the cmdlet to cancel the operation. This parameter should always be used with caution. </summary> </member> <member name="T:Eryph.ComputeClient.Commands.UnsafeAssemblyHandler"> <summary> This module initializer will redirect all assemblies in case we deliver a newer version. It is required as System.Text.Json uses System.Buffer and System.CompilerServices.Unsafe in a minimal higher version then included with .net framework 461. </summary> </member> </members> </doc> |