1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
//! `docker.RemoteImage` provides details about a specific Docker Image which needs to be present on the Docker Host
//!
//! ## Example Usage
//!
//! <!--Start PulumiCodeChooser -->
//! ### Typescript
//! ```typescript
//! import * as pulumi from "@pulumi/pulumi";
//! import * as docker from "@pulumi/docker";
//!
//! const latest = docker.getRemoteImage({
//! name: "nginx",
//! });
//! const specific = docker.getRemoteImage({
//! name: "nginx:1.17.6",
//! });
//! const digest = docker.getRemoteImage({
//! name: "nginx@sha256:36b74457bccb56fbf8b05f79c85569501b721d4db813b684391d63e02287c0b2",
//! });
//! const tagAndDigest = docker.getRemoteImage({
//! name: "nginx:1.19.1@sha256:36b74457bccb56fbf8b05f79c85569501b721d4db813b684391d63e02287c0b2",
//! });
//! ```
//! ### Python
//! ```python
//! import pulumi
//! import pulumi_docker as docker
//!
//! latest = docker.get_remote_image(name="nginx")
//! specific = docker.get_remote_image(name="nginx:1.17.6")
//! digest = docker.get_remote_image(name="nginx@sha256:36b74457bccb56fbf8b05f79c85569501b721d4db813b684391d63e02287c0b2")
//! tag_and_digest = docker.get_remote_image(name="nginx:1.19.1@sha256:36b74457bccb56fbf8b05f79c85569501b721d4db813b684391d63e02287c0b2")
//! ```
//! ### C#
//! ```csharp
//! using System.Collections.Generic;
//! using System.Linq;
//! using Pulumi;
//! using Docker = Pulumi.Docker;
//!
//! return await Deployment.RunAsync(() =>
//! {
//! var latest = Docker.GetRemoteImage.Invoke(new()
//! {
//! Name = "nginx",
//! });
//!
//! var specific = Docker.GetRemoteImage.Invoke(new()
//! {
//! Name = "nginx:1.17.6",
//! });
//!
//! var digest = Docker.GetRemoteImage.Invoke(new()
//! {
//! Name = "nginx@sha256:36b74457bccb56fbf8b05f79c85569501b721d4db813b684391d63e02287c0b2",
//! });
//!
//! var tagAndDigest = Docker.GetRemoteImage.Invoke(new()
//! {
//! Name = "nginx:1.19.1@sha256:36b74457bccb56fbf8b05f79c85569501b721d4db813b684391d63e02287c0b2",
//! });
//!
//! });
//! ```
//! ### Go
//! ```go
//! package main
//!
//! import (
//! "github.com/pulumi/pulumi-docker/sdk/v4/go/docker"
//! "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//! )
//!
//! func main() {
//! pulumi.Run(func(ctx *pulumi.Context) error {
//! _, err := docker.LookupRemoteImage(ctx, &docker.LookupRemoteImageArgs{
//! Name: "nginx",
//! }, nil)
//! if err != nil {
//! return err
//! }
//! _, err = docker.LookupRemoteImage(ctx, &docker.LookupRemoteImageArgs{
//! Name: "nginx:1.17.6",
//! }, nil)
//! if err != nil {
//! return err
//! }
//! _, err = docker.LookupRemoteImage(ctx, &docker.LookupRemoteImageArgs{
//! Name: "nginx@sha256:36b74457bccb56fbf8b05f79c85569501b721d4db813b684391d63e02287c0b2",
//! }, nil)
//! if err != nil {
//! return err
//! }
//! _, err = docker.LookupRemoteImage(ctx, &docker.LookupRemoteImageArgs{
//! Name: "nginx:1.19.1@sha256:36b74457bccb56fbf8b05f79c85569501b721d4db813b684391d63e02287c0b2",
//! }, nil)
//! if err != nil {
//! return err
//! }
//! return nil
//! })
//! }
//! ```
//! ### Java
//! ```java
//! package generated_program;
//!
//! import com.pulumi.Context;
//! import com.pulumi.Pulumi;
//! import com.pulumi.core.Output;
//! import com.pulumi.docker.DockerFunctions;
//! import com.pulumi.docker.inputs.GetRemoteImageArgs;
//! import java.util.List;
//! import java.util.ArrayList;
//! import java.util.Map;
//! import java.io.File;
//! import java.nio.file.Files;
//! import java.nio.file.Paths;
//!
//! public class App {
//! public static void main(String[] args) {
//! Pulumi.run(App::stack);
//! }
//!
//! public static void stack(Context ctx) {
//! final var latest = DockerFunctions.getRemoteImage(GetRemoteImageArgs.builder()
//! .name("nginx")
//! .build());
//!
//! final var specific = DockerFunctions.getRemoteImage(GetRemoteImageArgs.builder()
//! .name("nginx:1.17.6")
//! .build());
//!
//! final var digest = DockerFunctions.getRemoteImage(GetRemoteImageArgs.builder()
//! .name("nginx@sha256:36b74457bccb56fbf8b05f79c85569501b721d4db813b684391d63e02287c0b2")
//! .build());
//!
//! final var tagAndDigest = DockerFunctions.getRemoteImage(GetRemoteImageArgs.builder()
//! .name("nginx:1.19.1@sha256:36b74457bccb56fbf8b05f79c85569501b721d4db813b684391d63e02287c0b2")
//! .build());
//!
//! }
//! }
//! ```
//! ### YAML
//! ```yaml
//! variables:
//! latest:
//! fn::invoke:
//! Function: docker:getRemoteImage
//! Arguments:
//! name: nginx
//! specific:
//! fn::invoke:
//! Function: docker:getRemoteImage
//! Arguments:
//! name: nginx:1.17.6
//! digest:
//! fn::invoke:
//! Function: docker:getRemoteImage
//! Arguments:
//! name: nginx@sha256:36b74457bccb56fbf8b05f79c85569501b721d4db813b684391d63e02287c0b2
//! tagAndDigest:
//! fn::invoke:
//! Function: docker:getRemoteImage
//! Arguments:
//! name: nginx:1.19.1@sha256:36b74457bccb56fbf8b05f79c85569501b721d4db813b684391d63e02287c0b2
//! ```
//! <!--End PulumiCodeChooser -->
#[derive(bon::Builder)]
#[builder(finish_fn = build_struct)]
pub struct GetRemoteImageArgs {
/// The name of the Docker image, including any tags or SHA256 repo digests.
#[builder(into)]
pub name: pulumi_wasm_rust::Output<String>,
}
pub struct GetRemoteImageResult {
/// The provider-assigned unique ID for this managed resource.
pub id: pulumi_wasm_rust::Output<String>,
/// The name of the Docker image, including any tags or SHA256 repo digests.
pub name: pulumi_wasm_rust::Output<String>,
/// The image sha256 digest in the form of `repo[:tag]@sha256:<hash>`. It may be empty in the edge case where the local image was pulled from a repo, tagged locally, and then referred to in the data source by that local name/tag.
pub repo_digest: pulumi_wasm_rust::Output<String>,
}
///
/// Registers a new resource with the given unique name and arguments
///
pub fn invoke(
args: GetRemoteImageArgs
) -> GetRemoteImageResult {
let result = crate::bindings::pulumi::docker::get_remote_image::invoke(
&crate::bindings::pulumi::docker::get_remote_image::Args {
name: &args.name.get_inner(),
}
);
GetRemoteImageResult {
id: crate::into_domain(result.id),
name: crate::into_domain(result.name),
repo_digest: crate::into_domain(result.repo_digest),
}
}