Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

getPlugin

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

Schema

Optional

  • alias (String) The alias of the Docker plugin. If the tag is omitted, :latest is complemented to the attribute value.
  • id (String) The ID of the plugin, which has precedence over the alias of both are given

Read-Only

  • enabled (Boolean) If true the plugin is enabled
  • env (Set of String) The environment variables in the form of KEY=VALUE, e.g. DEBUG=0
  • grant_all_permissions (Boolean) If true, grant all permissions necessary to run the plugin
  • name (String) The plugin name. If the tag is omitted, :latest is complemented to the attribute value.
  • plugin_reference (String) The Docker Plugin Reference

Using getPlugin

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

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

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

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

The following arguments are supported:

Alias string
Id string
Alias string
Id string
alias string
id string
alias str
id str

getPlugin Result

The following output properties are available:

Enabled bool
Envs List<string>
GrantAllPermissions bool
Name string
PluginReference string
Alias string
Id string
Enabled bool
Envs []string
GrantAllPermissions bool
Name string
PluginReference string
Alias string
Id string
enabled boolean
envs string[]
grantAllPermissions boolean
name string
pluginReference string
alias string
id string
enabled bool
envs Sequence[str]
grant_all_permissions bool
name str
plugin_reference str
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.