ContainerImageManifestInspectionResult Methods

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

ClassMethods3 members

Represents the result of inspecting a container image manifest.

Failure(string, string?)staticContainerImageManifestInspectionResult

Creates a failed image manifest inspection result.

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

ContainerImageInspectionResult.cs#L317-L323

Parameters

errorMessagestringThe failure description.

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

Returns

ContainerImageManifestInspectionResultA failed image manifest inspection result.

Success(IReadOnlyList<ContainerImageManifest>, string?)staticContainerImageManifestInspectionResult

Creates a successful image manifest inspection result.

public sealed class ContainerImageManifestInspectionResult
{
    public static ContainerImageManifestInspectionResult Success(
        IReadOnlyList<ContainerImageManifest> manifests,
        string? rawJson = null)
    {
        // ...
    }
}

ContainerImageInspectionResult.cs#L297-L306

Parameters

manifestsIReadOnlyList<ContainerImageManifest>The inspected platform-specific image manifests.

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

Returns

ContainerImageManifestInspectionResultA successful image manifest inspection result.

TryGetManifest(string, string, ContainerImageManifest?)bool

Attempts to retrieve a manifest for the requested platform.

public sealed class ContainerImageManifestInspectionResult
{
    public bool TryGetManifest(
        string operatingSystem,
        string architecture,
        out ContainerImageManifest? manifest)
    {
        // ...
    }
}

ContainerImageInspectionResult.cs#L277-L284

Parameters

operatingSystemstringThe target operating system.

architecturestringThe target architecture.

manifestContainerImageManifest?The matching manifest when one is available.

Returns

booltrue when a matching manifest is available; otherwise, false.