Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

getPlugin

Reads the local Docker plugin. The plugin must be installed locally.

Example Usage

using Pulumi;
using Docker = Pulumi.Docker;

class MyStack : Stack
{
    public MyStack()
    {
        var sample_volume_plugin = Output.Create(Docker.GetPlugin.InvokeAsync(new Docker.GetPluginArgs
        {
            Alias = "sample-volume-plugin:latest",
        }));
    }

}
package main

import (
    "github.com/pulumi/pulumi-docker/sdk/v2/go/docker"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        opt0 := "sample-volume-plugin:latest"
        _, err := docker.LookupPlugin(ctx, &docker.LookupPluginArgs{
            Alias: &opt0,
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_docker as docker

sample_volume_plugin = docker.get_plugin(alias="sample-volume-plugin:latest")
import * as pulumi from "@pulumi/pulumi";
import * as docker from "@pulumi/docker";

const sample_volume_plugin = pulumi.output(docker.getPlugin({
    alias: "sample-volume-plugin:latest",
}, { async: true }));

Using getPlugin

function getPlugin(args: GetPluginArgs, opts?: InvokeOptions): Promise<GetPluginResult>
def get_plugin(alias: Optional[str] = None, id: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetPluginResult
func LookupPlugin(ctx *Context, args *LookupPluginArgs, opts ...InvokeOption) (*LookupPluginResult, error)

Note: This function is named LookupPlugin in the Go SDK.

public static class GetPlugin {
    public static Task<GetPluginResult> InvokeAsync(GetPluginArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Alias string

The alias of the Docker plugin.

Id string

The Docker plugin ID.

Alias string

The alias of the Docker plugin.

Id string

The Docker plugin ID.

alias string

The alias of the Docker plugin.

id string

The Docker plugin ID.

alias str

The alias of the Docker plugin.

id str

The Docker plugin ID.

getPlugin Result

The following output properties are available:

Enabled bool
Envs List<string>
GrantAllPermissions bool

(Optional, boolean) If true, grant all permissions necessary to run the plugin.

PluginReference string

(Optional, string, Forces new resource) The plugin reference.

Alias string
Id string
Enabled bool
Envs []string
GrantAllPermissions bool

(Optional, boolean) If true, grant all permissions necessary to run the plugin.

PluginReference string

(Optional, string, Forces new resource) The plugin reference.

Alias string
Id string
enabled boolean
envs string[]
grantAllPermissions boolean

(Optional, boolean) If true, grant all permissions necessary to run the plugin.

pluginReference string

(Optional, string, Forces new resource) The plugin reference.

alias string
id string
enabled bool
envs Sequence[str]
grant_all_permissions bool

(Optional, boolean) If true, grant all permissions necessary to run the plugin.

plugin_reference str

(Optional, string, Forces new resource) The plugin reference.

alias str
id str

Package Details

Repository
https://github.com/pulumi/pulumi-docker
License
Apache-2.0
Notes
This Pulumi package is based on the docker Terraform Provider.