coreclr/Eryph.ComputeClient.Commands.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Eryph.ComputeClient.Commands</name> </assembly> <members> <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="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.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="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. A name must be scoped to a project (<paramref name="projectName"/> is required) so that it cannot fan out across projects; within the project a wildcard may still match several resources. This keeps destructive operations from acting on same-named resources in other 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> </members> </doc> |