Docker

Pulumi Official
Package maintained by Pulumi
v3.2.0 published on Friday, Apr 1, 2022 by Pulumi

getPlugin

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

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)
}
public static CompletableFuture<GetPluginResult> getPlugin(GetPluginArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: docker:index/getPlugin:getPlugin
  Arguments:
    # Arguments dictionary

The following arguments are supported:

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

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

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

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

alias str

The alias of the Docker plugin. If the tag is omitted, :latest is complemented to the attribute value.

id str

The ID of the plugin, which has precedence over the alias of both are given

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

getPlugin Result

The following output properties are available:

Enabled bool

If true the plugin is enabled

Envs List<string>

The environment variables in the form of KEY=VALUE, e.g. DEBUG=0

GrantAllPermissions bool

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.

PluginReference string

The Docker Plugin Reference

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

Enabled bool

If true the plugin is enabled

Envs []string

The environment variables in the form of KEY=VALUE, e.g. DEBUG=0

GrantAllPermissions bool

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.

PluginReference string

The Docker Plugin Reference

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

enabled Boolean

If true the plugin is enabled

envs List<String>

The environment variables in the form of KEY=VALUE, e.g. DEBUG=0

grantAllPermissions 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.

pluginReference String

The Docker Plugin Reference

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

enabled boolean

If true the plugin is enabled

envs string[]

The environment variables in the form of KEY=VALUE, e.g. DEBUG=0

grantAllPermissions 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.

pluginReference string

The Docker Plugin Reference

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

enabled bool

If true the plugin is enabled

envs Sequence[str]

The environment variables in the form of KEY=VALUE, e.g. DEBUG=0

grant_all_permissions bool

If true, grant all permissions necessary to run the plugin

name str

The plugin name. If the tag is omitted, :latest is complemented to the attribute value.

plugin_reference str

The Docker Plugin Reference

alias str

The alias of the Docker plugin. If the tag is omitted, :latest is complemented to the attribute value.

id str

The ID of the plugin, which has precedence over the alias of both are given

enabled Boolean

If true the plugin is enabled

envs List<String>

The environment variables in the form of KEY=VALUE, e.g. DEBUG=0

grantAllPermissions 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.

pluginReference String

The Docker Plugin Reference

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

Package Details

Repository
https://github.com/pulumi/pulumi-docker
License
Apache-2.0
Notes

This Pulumi package is based on the docker Terraform Provider.