ContainerImageConfigInspectionResult Methods

1. Docs
2. /Reference
3. /Search C# APIs
4. /Aspire.Hosting
5. /ContainerImageConfigInspectionResult
6. /Methods

ClassMethods3 members

Represents the result of inspecting a container image configuration.

Failure(string, string?)staticContainerImageConfigInspectionResult

Creates a failed image configuration inspection result.

public sealed class ContainerImageConfigInspectionResult
{
    public static ContainerImageConfigInspectionResult Failure(
        string errorMessage,
        string? rawJson = null)
    {
        // ...
    }
}

ContainerImageInspectionResult.cs#L145-L151

Parameters

errorMessagestringThe failure description.

rawJsonstring?optionalThe runtime-native JSON returned by the inspection command, when available.

Returns

ContainerImageConfigInspectionResultA failed image configuration inspection result.

Success(ContainerImageConfig, string?)staticContainerImageConfigInspectionResult

Creates a successful image configuration inspection result.

public sealed class ContainerImageConfigInspectionResult
{
    public static ContainerImageConfigInspectionResult Success(
        ContainerImageConfig config,
        string? rawJson = null)
    {
        // ...
    }
}

ContainerImageInspectionResult.cs#L128-L134

Parameters

configContainerImageConfigThe inspected image configuration.

rawJsonstring?optionalThe runtime-native JSON returned by the inspection command, when available.

Returns

ContainerImageConfigInspectionResultA successful image configuration inspection result.

TryGetConfig(ContainerImageConfig?)bool

Attempts to retrieve the typed image configuration.

public sealed class ContainerImageConfigInspectionResult
{
    public bool TryGetConfig(
        out ContainerImageConfig? config)
    {
        // ...
    }
}

ContainerImageInspectionResult.cs#L113-L117

Parameters

configContainerImageConfig?The image configuration when inspection succeeded.

Returns

booltrue when typed configuration metadata is available; otherwise, false.