Updating help and associated functionality.
This commit is contained in:
Stefan J. Wernli
Родитель
1a8c86d481
Коммит
b2ccbae9b3
|
|
@ -4,10 +4,10 @@ using System.Threading.Tasks;
|
|||
|
||||
namespace Docker.PowerShell.Cmdlets
|
||||
{
|
||||
[Cmdlet(VerbsCommon.Set, "ContainerImageTag",
|
||||
[Cmdlet(VerbsCommon.Add, "ContainerImageTag",
|
||||
DefaultParameterSetName = CommonParameterSetNames.Default)]
|
||||
[Alias("Tag-ContainerImage")]
|
||||
public class SetContainerImageTag : ImageOperationCmdlet
|
||||
public class AddContainerImageTag : ImageOperationCmdlet
|
||||
{
|
||||
#region Parameters
|
||||
|
||||
|
|
@ -29,7 +29,7 @@ namespace Docker.PowerShell.Cmdlets
|
|||
|
||||
protected override async Task ProcessRecordAsync()
|
||||
{
|
||||
foreach (var id in ParameterResolvers.GetImageIds(Image, Id))
|
||||
foreach (var id in ParameterResolvers.GetImageIds(Image, ImageIdOrName))
|
||||
{
|
||||
var tagParams = new ImageTagParameters(){ RepositoryName = Repository };
|
||||
|
||||
|
|
@ -49,7 +49,7 @@ namespace Docker.PowerShell.Cmdlets
|
|||
|
||||
protected override async Task ProcessRecordAsync()
|
||||
{
|
||||
foreach (var id in ParameterResolvers.GetContainerIds(Container, Id))
|
||||
foreach (var id in ParameterResolvers.GetContainerIds(Container, ContainerIdOrName))
|
||||
{
|
||||
var commitResult = await DkrClient.Miscellaneous.CommitContainerChangesAsync(
|
||||
new CommitContainerChangesParameters() {
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ namespace Docker.PowerShell.Cmdlets
|
|||
{
|
||||
if (Container != null)
|
||||
{
|
||||
Id = Container.ID;
|
||||
ContainerIdOrName = Container.ID;
|
||||
}
|
||||
|
||||
if (ToContainer)
|
||||
|
|
@ -54,7 +54,7 @@ namespace Docker.PowerShell.Cmdlets
|
|||
|
||||
using (var reader = Archiver.CreateTarStream(hostPaths, CmdletCancellationToken, progress))
|
||||
{
|
||||
await DkrClient.Containers.ExtractArchiveToContainerAsync(Id, p, reader, CmdletCancellationToken);
|
||||
await DkrClient.Containers.ExtractArchiveToContainerAsync(ContainerIdOrName, p, reader, CmdletCancellationToken);
|
||||
}
|
||||
}
|
||||
else
|
||||
|
|
@ -67,7 +67,7 @@ namespace Docker.PowerShell.Cmdlets
|
|||
Path = singlePath
|
||||
};
|
||||
|
||||
var response = await DkrClient.Containers.GetArchiveFromContainerAsync(Id, p, false, CmdletCancellationToken);
|
||||
var response = await DkrClient.Containers.GetArchiveFromContainerAsync(ContainerIdOrName, p, false, CmdletCancellationToken);
|
||||
using (var stream = response.Stream)
|
||||
{
|
||||
var progress = new Progress<string>();
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ namespace Docker.PowerShell.Cmdlets
|
|||
{
|
||||
protected override async Task ProcessRecordAsync()
|
||||
{
|
||||
var id = Id ?? Container.ID;
|
||||
var id = ContainerIdOrName ?? Container.ID;
|
||||
|
||||
var inspect = await DkrClient.Containers.InspectContainerAsync(id);
|
||||
if (!inspect.State.Running || inspect.State.Paused)
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ namespace Docker.PowerShell.Cmdlets
|
|||
protected override async Task ProcessRecordAsync()
|
||||
{
|
||||
var filePath = System.IO.Path.Combine(SessionState.Path.CurrentFileSystemLocation.Path, DestinationFilePath);
|
||||
var names = new List<string>(ParameterResolvers.GetImageIds(Image, Id));
|
||||
var names = new List<string>(ParameterResolvers.GetImageIds(Image, ImageIdOrName));
|
||||
|
||||
using (var fs = File.Create(filePath))
|
||||
using (var stream = await DkrClient.Miscellaneous.GetImagesAsTarballAsync(names.ToArray(), CmdletCancellationToken))
|
||||
|
|
|
|||
|
|
@ -15,8 +15,8 @@ namespace Docker.PowerShell.Cmdlets
|
|||
Position = 0)]
|
||||
[ValidateNotNullOrEmpty]
|
||||
[ArgumentCompleter(typeof(ContainerArgumentCompleter))]
|
||||
[Alias("Name")]
|
||||
public string[] Id { get; set; }
|
||||
[Alias("Name","Id")]
|
||||
public string[] ContainerIdOrName { get; set; }
|
||||
|
||||
#region Overrides
|
||||
/// <summary>
|
||||
|
|
@ -24,9 +24,9 @@ namespace Docker.PowerShell.Cmdlets
|
|||
/// </summary>
|
||||
protected override async Task ProcessRecordAsync()
|
||||
{
|
||||
if (Id != null)
|
||||
if (ContainerIdOrName != null)
|
||||
{
|
||||
foreach (var id in Id)
|
||||
foreach (var id in ContainerIdOrName)
|
||||
{
|
||||
WriteObject(await ContainerOperations.GetContainersByIdOrName(id, DkrClient));
|
||||
}
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ namespace Docker.PowerShell.Cmdlets
|
|||
|
||||
protected override async Task ProcessRecordAsync()
|
||||
{
|
||||
foreach (var id in ParameterResolvers.GetContainerIds(Container, Id))
|
||||
foreach (var id in ParameterResolvers.GetContainerIds(Container, ContainerIdOrName))
|
||||
{
|
||||
WriteObject(await DkrClient.Containers.InspectContainerAsync(id));
|
||||
}
|
||||
|
|
|
|||
|
|
@ -20,8 +20,8 @@ namespace Docker.PowerShell.Cmdlets
|
|||
Position = 0)]
|
||||
[ValidateNotNullOrEmpty]
|
||||
[ArgumentCompleter(typeof(ImageArgumentCompleter))]
|
||||
[Alias("ImageName")]
|
||||
public string[] Id { get; set; }
|
||||
[Alias("ImageName", "ImageId")]
|
||||
public string[] ImageIdOrName { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Specifies whether all images should be shown, or just top level images.
|
||||
|
|
@ -37,13 +37,13 @@ namespace Docker.PowerShell.Cmdlets
|
|||
/// </summary>
|
||||
protected override async Task ProcessRecordAsync()
|
||||
{
|
||||
var listParams = new ImagesListParameters() { All = (All || Id != null) };
|
||||
var listParams = new ImagesListParameters() { All = (All || ImageIdOrName != null) };
|
||||
|
||||
foreach (var img in await DkrClient.Images.ListImagesAsync(listParams))
|
||||
{
|
||||
if (Id == null ||
|
||||
Id.Any(i => img.RepoTags.Any(r => i.Split('/').Last().Contains(":") ? r == i : r == (i + ":latest"))) ||
|
||||
Id.Any(i => img.ID.StartsWith(i) || img.ID.StartsWith("sha256:" + i)))
|
||||
if (ImageIdOrName == null ||
|
||||
ImageIdOrName.Any(i => img.RepoTags.Any(r => i.Split('/').Last().Contains(":") ? r == i : r == (i + ":latest"))) ||
|
||||
ImageIdOrName.Any(i => img.ID.StartsWith(i) || img.ID.StartsWith("sha256:" + i)))
|
||||
{
|
||||
WriteObject(img);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -16,8 +16,8 @@ namespace Docker.PowerShell.Cmdlets
|
|||
Mandatory = true)]
|
||||
[ValidateNotNullOrEmpty]
|
||||
[ArgumentCompleter(typeof(ImageArgumentCompleter))]
|
||||
[Alias("ImageName")]
|
||||
public string[] Id { get; set; }
|
||||
[Alias("ImageName", "ImageId")]
|
||||
public string[] ImageIdOrName { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The containers to remove.
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ namespace Docker.PowerShell.Cmdlets
|
|||
/// </summary>
|
||||
protected override async Task ProcessRecordAsync()
|
||||
{
|
||||
foreach (var id in ParameterResolvers.GetImageIds(Image, Id))
|
||||
foreach (var id in ParameterResolvers.GetImageIds(Image, ImageIdOrName))
|
||||
{
|
||||
var createResult = await ContainerOperations.CreateContainer(
|
||||
id,
|
||||
|
|
|
|||
|
|
@ -13,8 +13,8 @@ namespace Docker.PowerShell.Cmdlets
|
|||
Mandatory = true)]
|
||||
[ValidateNotNullOrEmpty]
|
||||
[ArgumentCompleter(typeof(ContainerArgumentCompleter))]
|
||||
[Alias("Name")]
|
||||
public string[] Id { get; set; }
|
||||
[Alias("Name", "Id")]
|
||||
public string[] ContainerIdOrName { get; set; }
|
||||
|
||||
[Parameter(ParameterSetName = CommonParameterSetNames.ContainerObject,
|
||||
ValueFromPipeline = true,
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ namespace Docker.PowerShell.Cmdlets
|
|||
/// </summary>
|
||||
protected override async Task ProcessRecordAsync()
|
||||
{
|
||||
foreach (var id in ParameterResolvers.GetImageIds(Image, Id))
|
||||
foreach (var id in ParameterResolvers.GetImageIds(Image, ImageIdOrName))
|
||||
{
|
||||
var createResult = await ContainerOperations.CreateContainer(
|
||||
id,
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ namespace Docker.PowerShell.Cmdlets
|
|||
|
||||
protected override async Task ProcessRecordAsync()
|
||||
{
|
||||
foreach (var id in ParameterResolvers.GetContainerIds(Container, Id))
|
||||
foreach (var id in ParameterResolvers.GetContainerIds(Container, ContainerIdOrName))
|
||||
{
|
||||
await DkrClient.Containers.RemoveContainerAsync(id,
|
||||
new ContainerRemoveParameters() { Force = Force.ToBool() }
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ namespace Docker.PowerShell.Cmdlets
|
|||
|
||||
protected override async Task ProcessRecordAsync()
|
||||
{
|
||||
foreach (var id in ParameterResolvers.GetImageIds(Image, Id))
|
||||
foreach (var id in ParameterResolvers.GetImageIds(Image, ImageIdOrName))
|
||||
{
|
||||
await DkrClient.Images.DeleteImageAsync(id,
|
||||
new ImageDeleteParameters() { Force = Force.ToBool() }
|
||||
|
|
|
|||
|
|
@ -13,8 +13,8 @@ namespace Docker.PowerShell.Cmdlets
|
|||
Mandatory = true)]
|
||||
[ValidateNotNullOrEmpty]
|
||||
[ArgumentCompleter(typeof(ContainerArgumentCompleter))]
|
||||
[Alias("Name")]
|
||||
public string Id { get; set; }
|
||||
[Alias("Name", "Id")]
|
||||
public string ContainerIdOrName { get; set; }
|
||||
|
||||
[Parameter(ParameterSetName = CommonParameterSetNames.ContainerObject,
|
||||
ValueFromPipeline = true,
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ namespace Docker.PowerShell.Cmdlets
|
|||
|
||||
protected override async Task ProcessRecordAsync()
|
||||
{
|
||||
foreach (var id in ParameterResolvers.GetContainerIds(Container, Id))
|
||||
foreach (var id in ParameterResolvers.GetContainerIds(Container, ContainerIdOrName))
|
||||
{
|
||||
ContainerAttachParameters attachParams = null;
|
||||
if (this.Attach)
|
||||
|
|
|
|||
|
|
@ -61,7 +61,7 @@ namespace Docker.PowerShell.Cmdlets
|
|||
|
||||
protected override async Task ProcessRecordAsync()
|
||||
{
|
||||
var id = Id ?? Container.ID;
|
||||
var id = ContainerIdOrName ?? Container.ID;
|
||||
|
||||
var execConfig = new ExecConfig()
|
||||
{
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ namespace Docker.PowerShell.Cmdlets
|
|||
|
||||
protected override async Task ProcessRecordAsync()
|
||||
{
|
||||
foreach (var id in ParameterResolvers.GetContainerIds(Container, Id))
|
||||
foreach (var id in ParameterResolvers.GetContainerIds(Container, ContainerIdOrName))
|
||||
{
|
||||
if (Force)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -22,8 +22,8 @@ namespace Docker.PowerShell.Cmdlets
|
|||
Mandatory = true)]
|
||||
[ValidateNotNullOrEmpty]
|
||||
[ArgumentCompleter(typeof(ImageArgumentCompleter))]
|
||||
[Alias("ImageName")]
|
||||
public string Id { get; set; }
|
||||
[Alias("ImageName", "ImageId")]
|
||||
public string ImageIdOrName { get; set; }
|
||||
|
||||
[Parameter(ParameterSetName = CommonParameterSetNames.ImageObject,
|
||||
ValueFromPipeline = true,
|
||||
|
|
@ -43,9 +43,9 @@ namespace Docker.PowerShell.Cmdlets
|
|||
{
|
||||
string repoTag = null;
|
||||
|
||||
if (Id != null)
|
||||
if (ImageIdOrName != null)
|
||||
{
|
||||
repoTag = Id;
|
||||
repoTag = ImageIdOrName;
|
||||
}
|
||||
else if (Image.RepoTags.Count != 1)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ namespace Docker.PowerShell.Cmdlets
|
|||
|
||||
protected override async Task ProcessRecordAsync()
|
||||
{
|
||||
foreach (var id in ParameterResolvers.GetContainerIds(Container, Id))
|
||||
foreach (var id in ParameterResolvers.GetContainerIds(Container, ContainerIdOrName))
|
||||
{
|
||||
var waitResponse = await DkrClient.Containers.WaitContainerAsync(
|
||||
id,
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ CmdletsToExport = @(
|
|||
'Remove-ContainerNet',
|
||||
'Invoke-ContainerImage',
|
||||
'Request-ContainerImage',
|
||||
'Set-ContainerImageTag',
|
||||
'Add-ContainerImageTag',
|
||||
'Start-Container',
|
||||
'Start-ContainerProcess',
|
||||
'Stop-Container',
|
||||
|
|
|
|||
|
|
@ -4,37 +4,39 @@ online version:
|
|||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Set-ContainerImageTag
|
||||
# Add-ContainerImageTag
|
||||
## SYNOPSIS
|
||||
{{Fill in the Synopsis}}
|
||||
Adds a repository and tag to the given image.
|
||||
Aliased as "Tag-ContainerImage".
|
||||
## SYNTAX
|
||||
|
||||
### Default (Default)
|
||||
```
|
||||
Set-ContainerImageTag [-Force] [-Repository] <String> [[-Tag] <String>] [-Id] <String[]>
|
||||
Add-ContainerImageTag [-Force] [-Repository] <String> [[-Tag] <String>] [-ImageIdOrName] <String[]>
|
||||
[-HostAddress <String>] [-CertificateLocation <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### ImageObject
|
||||
```
|
||||
Set-ContainerImageTag [-Force] [-Repository] <String> [[-Tag] <String>] [-Image] <ImagesListResponse[]>
|
||||
Add-ContainerImageTag [-Force] [-Repository] <String> [[-Tag] <String>] [-Image] <ImagesListResponse[]>
|
||||
[-HostAddress <String>] [-CertificateLocation <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
{{Fill in the Description}}
|
||||
Adds a repository and tag to the given image.
|
||||
Aliased as "Tag-ContainerImage".
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> {{ Add example code here }}
|
||||
PS C:\> Add-ContainerImageTag -ImageIdOrName 5b61 -Repository myImage -Tag 1.4
|
||||
```
|
||||
|
||||
{{ Add example description here }}
|
||||
Add the repository/tag "myImage:1.4" to the image with id "5b61".
|
||||
## PARAMETERS
|
||||
|
||||
### -CertificateLocation
|
||||
{{Fill CertificateLocation Description}}
|
||||
The location of the X509 certificate file named "key.pfx" that will be used for authentication with the server. (Note that certificate authorization work is still in progress and this is likely to change).
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -49,7 +51,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Force
|
||||
{{Fill Force Description}}
|
||||
Completes the operation without prompting for confirmation.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
|
|
@ -64,7 +66,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -HostAddress
|
||||
{{Fill HostAddress Description}}
|
||||
The address of the docker daemon to connect to.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -78,23 +80,8 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Id
|
||||
{{Fill Id Description}}
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: ImageName
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Image
|
||||
{{Fill Image Description}}
|
||||
The image the tag will be added to.
|
||||
|
||||
```yaml
|
||||
Type: ImagesListResponse[]
|
||||
|
|
@ -109,7 +96,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Repository
|
||||
{{Fill Repository Description}}
|
||||
The new repository value that will be added to the image.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -124,7 +111,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Tag
|
||||
{{Fill Tag Description}}
|
||||
The new tag value that will be added to the image.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -138,6 +125,21 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ImageIdOrName
|
||||
The Id or Name of the image the tag will be added to.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: ImageName, ImageId
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### CommonParameters
|
||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
## INPUTS
|
||||
|
|
@ -152,3 +154,4 @@ Docker.DotNet.Models.ImagesListResponse[]
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Add-ContainerImageTag.md)
|
||||
|
|
@ -5,16 +5,15 @@ schema: 2.0.0
|
|||
|
||||
# ConvertTo-ContainerImage
|
||||
## SYNOPSIS
|
||||
ConvertTo-ContainerImage \[-Id\] \<string\[\]\> \[-Repository \<string\>\] \[-Tag \<string\>\] \[-Message \<string\>\] \[-Author \<string\>\] \[-Configuration \<Config\>\] \[-HostAddress \<string\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
|
||||
ConvertTo-ContainerImage \[-Container\] \<ContainerListResponse\[\]\> \[-Repository \<string\>\] \[-Tag \<string\>\] \[-Message \<string\>\] \[-Author \<string\>\] \[-Configuration \<Config\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
Creates a new container image by committing an existing container.
|
||||
Aliased as "Commit-Container".
|
||||
## SYNTAX
|
||||
|
||||
### Default (Default)
|
||||
```
|
||||
ConvertTo-ContainerImage [-Repository <String>] [-Tag <String>] [-Message <String>] [-Author <String>]
|
||||
[-Configuration <Config>] [-Id] <String[]> [-HostAddress <String>] [-CertificateLocation <String>]
|
||||
[<CommonParameters>]
|
||||
[-Configuration <Config>] [-ContainerIdOrName] <String[]> [-HostAddress <String>]
|
||||
[-CertificateLocation <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### ContainerObject
|
||||
|
|
@ -25,19 +24,22 @@ ConvertTo-ContainerImage [-Repository <String>] [-Tag <String>] [-Message <Strin
|
|||
```
|
||||
|
||||
## DESCRIPTION
|
||||
{{Fill in the Description}}
|
||||
Creates a new container image by committing an existing container.
|
||||
Aliased as "Commit-Container".
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> {{ Add example code here }}
|
||||
PS C:\> New-Container -Name myContainer -Image $myImage -Command myWorkload.exe
|
||||
PS C:\> Start-Container myContainer | Wait-Container
|
||||
PS C:\> ConvertTo-ContainerImage -ContainerIdOrName myContainer -Repository myWorkloadImage
|
||||
```
|
||||
|
||||
{{ Add example description here }}
|
||||
Creates a new container named "myContainer" that runs the application "myWorkload.exe", starts it, waits for it to complete, then commits the completed container as a new image named "myWorkloadImage".
|
||||
## PARAMETERS
|
||||
|
||||
### -Author
|
||||
{{Fill Author Description}}
|
||||
Specifies the value for the Author metadata on the resulting image.
|
||||
|
||||
|
||||
|
||||
|
|
@ -56,8 +58,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -CertificateLocation
|
||||
{{Fill CertificateLocation Description}}
|
||||
|
||||
The location of the X509 certificate file named "key.pfx" that will be used for authentication with the server. (Note that certificate authorization work is still in progress and this is likely to change).
|
||||
|
||||
|
||||
|
||||
|
|
@ -75,8 +76,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Configuration
|
||||
{{Fill Configuration Description}}
|
||||
|
||||
An instance of a Docker.DotNet.Models.Config object with desired configuration values filled out.
|
||||
|
||||
|
||||
|
||||
|
|
@ -94,7 +94,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Container
|
||||
{{Fill Container Description}}
|
||||
Specifies the container to be committed as a new image.
|
||||
|
||||
|
||||
|
||||
|
|
@ -113,7 +113,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -HostAddress
|
||||
{{Fill HostAddress Description}}
|
||||
The address of the docker daemon to connect to.
|
||||
|
||||
|
||||
|
||||
|
|
@ -131,27 +131,8 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Id
|
||||
{{Fill Id Description}}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: Name
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Message
|
||||
{{Fill Message Description}}
|
||||
Specifies the value for the Message metadata on the resulting image.
|
||||
|
||||
|
||||
|
||||
|
|
@ -170,7 +151,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Repository
|
||||
{{Fill Repository Description}}
|
||||
Specifies the Repository name to use for the new image.
|
||||
|
||||
|
||||
|
||||
|
|
@ -189,7 +170,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Tag
|
||||
{{Fill Tag Description}}
|
||||
Optionally specifies the Tag to use for the new image. If no Tag is supplied, defaults to "latest".
|
||||
|
||||
|
||||
|
||||
|
|
@ -207,6 +188,21 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ContainerIdOrName
|
||||
Specifies the container by Id or Name that will be committed into the new image.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: Name, Id
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### CommonParameters
|
||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
## INPUTS
|
||||
|
|
@ -221,7 +217,7 @@ Docker.DotNet.Models.ContainerListResponse[]
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:]()
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/ConvertTo-ContainerImage.md)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -5,14 +5,12 @@ schema: 2.0.0
|
|||
|
||||
# Copy-ContainerFile
|
||||
## SYNOPSIS
|
||||
Copy-ContainerFile \[-Id\] \<string\> \[-Path\] \<string\[\]\> \[-Destination \<string\>\] \[-ToContainer\] \[-HostAddress \<string\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
|
||||
Copy-ContainerFile \[-Container\] \<ContainerListResponse\> \[-Path\] \<string\[\]\> \[-Destination \<string\>\] \[-ToContainer\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
Copies a file between container and host.
|
||||
## SYNTAX
|
||||
|
||||
### Default (Default)
|
||||
```
|
||||
Copy-ContainerFile [-Path] <String[]> [-Destination <String>] [-ToContainer] [-Id] <String>
|
||||
Copy-ContainerFile [-Path] <String[]> [-Destination <String>] [-ToContainer] [-ContainerIdOrName] <String>
|
||||
[-HostAddress <String>] [-CertificateLocation <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
|
|
@ -29,10 +27,16 @@ Copies a file between container and host.
|
|||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> {{ Copy-ContainerFile -stuff }}
|
||||
PS C:\> Copy-ContainerFile -ContainerIdOrName myContainer -Path $filepathInsideContainer -Destination c:\test\
|
||||
```
|
||||
|
||||
Copies a file into container
|
||||
Copies a file located at $filepathInsideContainer out of the container to the folder "c:\test\" on the host.
|
||||
### Example 2
|
||||
```
|
||||
PS C:\> Copy-ContainerFile -ContainerIdOrName myContainer -ToContainer -Path $filepathOnHost -Destination c:\test\
|
||||
```
|
||||
|
||||
Copies a file located at $filepathOnHost on the host to the folder "c:\test\" in the container.
|
||||
## PARAMETERS
|
||||
|
||||
### -CertificateLocation
|
||||
|
|
@ -74,7 +78,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Destination
|
||||
Destination location for the file.
|
||||
Destination folder for the file.
|
||||
|
||||
|
||||
|
||||
|
|
@ -111,25 +115,6 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Id
|
||||
Id of the container to copy a file to/from.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Default
|
||||
Aliases: Name
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Path
|
||||
The path of the file to copy.
|
||||
|
||||
|
|
@ -150,7 +135,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -ToContainer
|
||||
Specifies that the file will be copied from the host into the container.
|
||||
Specifies that the file will be copied from the host into the container. Otherwise, the file is copied from the container to the host.
|
||||
|
||||
|
||||
|
||||
|
|
@ -167,6 +152,21 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ContainerIdOrName
|
||||
Specifies the container by Id or Name.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Default
|
||||
Aliases: Name, Id
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### CommonParameters
|
||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
## INPUTS
|
||||
|
|
@ -181,7 +181,7 @@ Docker.DotNet.Models.ContainerListResponse
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell)
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Copy-ContainerFile.md)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -5,14 +5,13 @@ schema: 2.0.0
|
|||
|
||||
# Enter-ContainerSession
|
||||
## SYNOPSIS
|
||||
Enter-ContainerSession \[-Id\] \<string\> \[-HostAddress \<string\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
|
||||
Enter-ContainerSession \[-Container\] \<ContainerListResponse\> \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
Connects to interactive session in the specified container.
|
||||
Aliased as "Attach-Container".
|
||||
## SYNTAX
|
||||
|
||||
### Default (Default)
|
||||
```
|
||||
Enter-ContainerSession [-Id] <String> [-HostAddress <String>] [-CertificateLocation <String>]
|
||||
Enter-ContainerSession [-ContainerIdOrName] <String> [-HostAddress <String>] [-CertificateLocation <String>]
|
||||
[<CommonParameters>]
|
||||
```
|
||||
|
||||
|
|
@ -24,11 +23,12 @@ Enter-ContainerSession [-Container] <ContainerListResponse> [-HostAddress <Strin
|
|||
|
||||
## DESCRIPTION
|
||||
Connects to interactive session in the specified container.
|
||||
Aliased as "Attach-Container".
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> {{ Enter-ContainerSession $myContainer}}
|
||||
PS C:\> Enter-ContainerSession $myContainer
|
||||
```
|
||||
|
||||
Connects to $myContainer
|
||||
|
|
@ -91,17 +91,13 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Id
|
||||
Specifies the container by id or name. You can pass a subset of the ID if it is unique.
|
||||
|
||||
|
||||
|
||||
|
||||
### -ContainerIdOrName
|
||||
Specifies the container by Id or Name to connect to.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Default
|
||||
Aliases: Name
|
||||
Aliases: Name, Id
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
|
|
@ -124,7 +120,7 @@ Docker.DotNet.Models.ContainerListResponse
|
|||
These are some notes about the cmdlet.
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell)
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Enter-ContainerSession.md)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -6,12 +6,13 @@ schema: 2.0.0
|
|||
|
||||
# Export-ContainerImage
|
||||
## SYNOPSIS
|
||||
{{Fill in the Synopsis}}
|
||||
Exports the container image, including all layers, into a single compressed file.
|
||||
Aliased to "Save-ContainerImage".
|
||||
## SYNTAX
|
||||
|
||||
### Default (Default)
|
||||
```
|
||||
Export-ContainerImage -DestinationFilePath <String> [-Id] <String[]> [-HostAddress <String>]
|
||||
Export-ContainerImage -DestinationFilePath <String> [-ImageIdOrName] <String[]> [-HostAddress <String>]
|
||||
[-CertificateLocation <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
|
|
@ -22,19 +23,20 @@ Export-ContainerImage -DestinationFilePath <String> [-Image] <ImagesListResponse
|
|||
```
|
||||
|
||||
## DESCRIPTION
|
||||
{{Fill in the Description}}
|
||||
Exports the container image, including all layers, into a single compressed file.
|
||||
Aliased to "Save-ContainerImage".
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> {{ Add example code here }}
|
||||
PS C:\> Export-ContainerImage -ImageIdOrName myImage -DestinationFilePath c:\myImage.tar
|
||||
```
|
||||
|
||||
{{ Add example description here }}
|
||||
Exports all layers for the image "myImage" to the compressed file "c:\myImage.tar".
|
||||
## PARAMETERS
|
||||
|
||||
### -CertificateLocation
|
||||
{{Fill CertificateLocation Description}}
|
||||
The location of the X509 certificate file named "key.pfx" that will be used for authentication with the server. (Note that certificate authorization work is still in progress and this is likely to change).
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -49,7 +51,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -HostAddress
|
||||
{{Fill HostAddress Description}}
|
||||
The address of the docker daemon to connect to.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -63,23 +65,8 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Id
|
||||
{{Fill Id Description}}
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: ImageName
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Image
|
||||
{{Fill Image Description}}
|
||||
The image that will be exported to a file.
|
||||
|
||||
```yaml
|
||||
Type: ImagesListResponse[]
|
||||
|
|
@ -94,7 +81,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -DestinationFilePath
|
||||
{{Fill DestinationFilePath Description}}
|
||||
The path to export the image to.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -108,6 +95,21 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ImageIdOrName
|
||||
The Name or Id of the image that will be exported.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: ImageName, ImageId
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### CommonParameters
|
||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
## INPUTS
|
||||
|
|
@ -122,3 +124,4 @@ Docker.DotNet.Models.ImagesListResponse[]
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Export-ContainerImage.md)
|
||||
|
|
|
|||
|
|
@ -5,11 +5,12 @@ schema: 2.0.0
|
|||
|
||||
# Get-Container
|
||||
## SYNOPSIS
|
||||
Get-Container \[-HostAddress \<string\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
Returns a list of containers.
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Get-Container [[-Id] <String[]>] [-HostAddress <String>] [-CertificateLocation <String>] [<CommonParameters>]
|
||||
Get-Container [[-ContainerIdOrName] <String[]>] [-HostAddress <String>] [-CertificateLocation <String>]
|
||||
[<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
|
|
@ -62,13 +63,13 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Id
|
||||
{{Fill Id Description}}
|
||||
### -ContainerIdOrName
|
||||
An array of names or ids of the containers to be retrieved.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases: Name
|
||||
Aliases: Name, Id
|
||||
|
||||
Required: False
|
||||
Position: 0
|
||||
|
|
@ -91,7 +92,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:]()
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Get-Container.md)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -5,14 +5,12 @@ schema: 2.0.0
|
|||
|
||||
# Get-ContainerDetail
|
||||
## SYNOPSIS
|
||||
Get-ContainerDetail \[-Id\] \<string\[\]\> \[-HostAddress \<string\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
|
||||
Get-ContainerDetail \[-Container\] \<ContainerListResponse\[\]\> \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
Gets details about a container.
|
||||
## SYNTAX
|
||||
|
||||
### Default (Default)
|
||||
```
|
||||
Get-ContainerDetail [-Id] <String[]> [-HostAddress <String>] [-CertificateLocation <String>]
|
||||
Get-ContainerDetail [-ContainerIdOrName] <String[]> [-HostAddress <String>] [-CertificateLocation <String>]
|
||||
[<CommonParameters>]
|
||||
```
|
||||
|
||||
|
|
@ -28,10 +26,10 @@ Gets details about a container.
|
|||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> Get-ContainerDetail
|
||||
PS C:\> Get-ContainerDetail myContainer
|
||||
```
|
||||
|
||||
Gets details about a container.
|
||||
Gets details about the container "myContainer".
|
||||
## PARAMETERS
|
||||
|
||||
### -CertificateLocation
|
||||
|
|
@ -91,17 +89,13 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Id
|
||||
Specifies the id of the container to get details for. This parameter also accepts container name, or a unique subset of the id.
|
||||
|
||||
|
||||
|
||||
|
||||
### -ContainerIdOrName
|
||||
Specifies the Id or Name of the container to get the details for.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: Name
|
||||
Aliases: Name, Id
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
|
|
@ -124,7 +118,7 @@ Docker.DotNet.Models.ContainerListResponse[]
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:]()
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Get-ContainerDetail.md)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -5,12 +5,12 @@ schema: 2.0.0
|
|||
|
||||
# Get-ContainerImage
|
||||
## SYNOPSIS
|
||||
Get-ContainerImage \[-All\] \[-HostAddress \<string\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
Returns container images.
|
||||
## SYNTAX
|
||||
|
||||
### Default (Default)
|
||||
```
|
||||
Get-ContainerImage [[-Id] <String[]>] [-HostAddress <String>] [-CertificateLocation <String>]
|
||||
Get-ContainerImage [[-ImageIdOrName] <String[]>] [-HostAddress <String>] [-CertificateLocation <String>]
|
||||
[<CommonParameters>]
|
||||
```
|
||||
|
||||
|
|
@ -32,7 +32,7 @@ Returns a list of container images.
|
|||
## PARAMETERS
|
||||
|
||||
### -All
|
||||
Specifies that all images should be retrieved.
|
||||
Specifies that all images should be retrieved. Otherwise, intermediate images are suppressed.
|
||||
|
||||
|
||||
|
||||
|
|
@ -88,13 +88,13 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Id
|
||||
{{Fill Id Description}}
|
||||
### -ImageIdOrName
|
||||
An array of names or ids of the images to be retrieved
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: ImageName
|
||||
Aliases: ImageName, ImageId
|
||||
|
||||
Required: False
|
||||
Position: 0
|
||||
|
|
@ -117,7 +117,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:]()
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Get-ContainerImage.md)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ schema: 2.0.0
|
|||
|
||||
# Get-ContainerNet
|
||||
## SYNOPSIS
|
||||
Get-ContainerNet \[-HostAddress \<string\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
Gets a network endpoint.
|
||||
## SYNTAX
|
||||
|
||||
### NetworkName (Default)
|
||||
|
|
@ -21,15 +21,15 @@ Get-ContainerNet [[-Id] <String[]>] [-HostAddress <String>] [-CertificateLocatio
|
|||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Gets a container network.
|
||||
Gets a network endpoint.
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> Get-ContainerNet -Name mycontainer
|
||||
PS C:\> Get-ContainerNet -Name myNatNetwork
|
||||
```
|
||||
|
||||
Gets network information for the container "mycontainer"
|
||||
Gets network endpoint information for the network "myNatNetwork".
|
||||
## PARAMETERS
|
||||
|
||||
### -CertificateLocation
|
||||
|
|
@ -71,7 +71,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Id
|
||||
{{Fill Id Description}}
|
||||
Specifies the Id of the network endpoint.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
|
|
@ -86,7 +86,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Name
|
||||
{{Fill Name Description}}
|
||||
Specifies the Name of the network endpoint.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
|
|
@ -114,7 +114,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:]()
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Get-ContainerNet.md)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ schema: 2.0.0
|
|||
|
||||
# Get-ContainerNetDetail
|
||||
## SYNOPSIS
|
||||
Get-ContainerNetDetail \[-Name\] \<string\> \[-HostAddress \<string\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
Gets details about a network endpoint.
|
||||
## SYNTAX
|
||||
|
||||
### Default
|
||||
|
|
@ -21,15 +21,15 @@ Get-ContainerNetDetail [-Network] <NetworkListResponse[]> [-HostAddress <String>
|
|||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Gets details about a container's network.
|
||||
Gets details about a network endpoint.
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> Get-ContainerNetDetail -Name mycontainer
|
||||
PS C:\> Get-ContainerNetDetail -Name myNatNetwork
|
||||
```
|
||||
|
||||
Gets network details for the container "mycontainer"
|
||||
Gets network endpoint details for the network "myNatNetwork"
|
||||
## PARAMETERS
|
||||
|
||||
### -CertificateLocation
|
||||
|
|
@ -71,7 +71,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Id
|
||||
{{Fill Id Description}}
|
||||
Specifies the Id of the network endpoint.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
|
|
@ -86,7 +86,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Network
|
||||
{{Fill Network Description}}
|
||||
Specifies the network endpoint.
|
||||
|
||||
```yaml
|
||||
Type: NetworkListResponse[]
|
||||
|
|
@ -114,7 +114,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:]()
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Get-ContainerNetDetail.md)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,8 @@ schema: 2.0.0
|
|||
|
||||
# Import-ContainerImage
|
||||
## SYNOPSIS
|
||||
{{Fill in the Synopsis}}
|
||||
Imports the container image, including all layers, from a single compressed file.
|
||||
Aliased to "Load-ContainerImage".
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
|
|
@ -15,19 +16,20 @@ Import-ContainerImage [-FilePath] <String[]> [-HostAddress <String>] [-Certifica
|
|||
```
|
||||
|
||||
## DESCRIPTION
|
||||
{{Fill in the Description}}
|
||||
Imports the container image, including all layers, from a single compressed file.
|
||||
Aliased to "Load-ContainerImage".
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> {{ Add example code here }}
|
||||
PS C:\> Import-ContainerImage -FilePath c:\myImage.tar
|
||||
```
|
||||
|
||||
{{ Add example description here }}
|
||||
Imports the image from the file "c:\myImage.tar".
|
||||
## PARAMETERS
|
||||
|
||||
### -CertificateLocation
|
||||
{{Fill CertificateLocation Description}}
|
||||
The location of the X509 certificate file named "key.pfx" that will be used for authentication with the server. (Note that certificate authorization work is still in progress and this is likely to change).
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -42,7 +44,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -FilePath
|
||||
{{Fill FilePath Description}}
|
||||
The path to the file to be imported.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
|
|
@ -57,7 +59,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -HostAddress
|
||||
{{Fill HostAddress Description}}
|
||||
The address of the docker daemon to connect to.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -85,3 +87,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Import-ContainerImage.md)
|
||||
|
|
|
|||
|
|
@ -5,18 +5,15 @@ schema: 2.0.0
|
|||
|
||||
# Invoke-ContainerImage
|
||||
## SYNOPSIS
|
||||
Invoke-ContainerImage \[-Id\] \<string\[\]\> \[\[-Command\] \<string\[\]\>\] \[-RemoveAutomatically\] \[-PassThru\] \[-ContainerName \<string\>\] \[-Isolation \<IsolationType\>\] \[-Configuration \<Config\>\] \[-HostConfiguration \<HostConfig\>\] \[-Input\] \[-Terminal\] \[-HostAddress \<string\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
|
||||
Invoke-ContainerImage \[-Image\] \<ImagesListResponse\[\]\> \[\[-Command\] \<string\[\]\>\] \[-RemoveAutomatically\] \[-PassThru\] \[-ContainerName \<string\>\] \[-Isolation \<IsolationType\>\] \[-Configuration \<Config\>\] \[-HostConfiguration \<HostConfig\>\] \[-Input\] \[-Terminal\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
|
||||
Invoke-ContainerImage \[-Configuration\] \<Config\> \[-RemoveAutomatically\] \[-PassThru\] \[-HostConfiguration \<HostConfig\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
Runs a container from an existing image.
|
||||
Aliased as "Run-Container".
|
||||
## SYNTAX
|
||||
|
||||
### Default (Default)
|
||||
```
|
||||
Invoke-ContainerImage [-RemoveAutomatically] [-PassThru] [-Detach] [-Name <String>] [[-Command] <String[]>]
|
||||
[-Isolation <IsolationType>] [-Configuration <Config>] [-HostConfiguration <HostConfig>] [-Input] [-Terminal]
|
||||
[-Id] <String[]> [-HostAddress <String>] [-CertificateLocation <String>] [<CommonParameters>]
|
||||
[-ImageIdOrName] <String[]> [-HostAddress <String>] [-CertificateLocation <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### ImageObject
|
||||
|
|
@ -34,18 +31,19 @@ Invoke-ContainerImage [-RemoveAutomatically] [-PassThru] [-Detach] -Configuratio
|
|||
|
||||
## DESCRIPTION
|
||||
Runs a container from an existing image.
|
||||
Aliased as "Run-Container".
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> Invoke-ContainerImage -id 903ef
|
||||
PS C:\> Invoke-ContainerImage -ImageIdOrName 903ef
|
||||
```
|
||||
|
||||
Starts a container using the image with id 903ef.
|
||||
## PARAMETERS
|
||||
|
||||
### -CertificateLocation
|
||||
Specifies the certificate location.
|
||||
The location of the X509 certificate file named "key.pfx" that will be used for authentication with the server. (Note that certificate authorization work is still in progress and this is likely to change).
|
||||
|
||||
|
||||
|
||||
|
|
@ -151,25 +149,6 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Id
|
||||
The id of the container image.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: ImageName
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Image
|
||||
Specifies the container image.
|
||||
|
||||
|
|
@ -229,7 +208,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Name
|
||||
{{Fill Name Description}}
|
||||
Specifies the name of the newly created container.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -282,7 +261,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Terminal
|
||||
Gives a terminal in the new container.
|
||||
Enables terminal emulation in the new container.
|
||||
|
||||
|
||||
|
||||
|
|
@ -315,6 +294,21 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ImageIdOrName
|
||||
The Id or Name of the image the container is created from.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: ImageName, ImageId
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### CommonParameters
|
||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
## INPUTS
|
||||
|
|
@ -330,7 +324,7 @@ Docker.DotNet.Models.ImagesListResponse[]
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:]()
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Invoke-ContainerImage.md)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -5,17 +5,13 @@ schema: 2.0.0
|
|||
|
||||
# New-Container
|
||||
## SYNOPSIS
|
||||
New-Container \[-Id\] \<string\[\]\> \[\[-Command\] \<string\[\]\>\] \[-ContainerName \<string\>\] \[-Isolation \<IsolationType\>\] \[-Configuration \<Config\>\] \[-HostConfiguration \<HostConfig\>\] \[-Input\] \[-Terminal\] \[-HostAddress \<string\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
|
||||
New-Container \[-Image\] \<ImagesListResponse\[\]\> \[\[-Command\] \<string\[\]\>\] \[-ContainerName \<string\>\] \[-Isolation \<IsolationType\>\] \[-Configuration \<Config\>\] \[-HostConfiguration \<HostConfig\>\] \[-Input\] \[-Terminal\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
|
||||
New-Container \[-Configuration\] \<Config\> \[-HostConfiguration \<HostConfig\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
Creates a new container.
|
||||
## SYNTAX
|
||||
|
||||
### Default (Default)
|
||||
```
|
||||
New-Container [-Name <String>] [[-Command] <String[]>] [-Isolation <IsolationType>] [-Configuration <Config>]
|
||||
[-HostConfiguration <HostConfig>] [-Input] [-Terminal] [-Id] <String[]> [-HostAddress <String>]
|
||||
[-HostConfiguration <HostConfig>] [-Input] [-Terminal] [-ImageIdOrName] <String[]> [-HostAddress <String>]
|
||||
[-CertificateLocation <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
|
|
@ -38,10 +34,10 @@ Creates a new container.
|
|||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> New-Container -Id 4179ed
|
||||
PS C:\> New-Container -ImageIdOrName 4179ed
|
||||
```
|
||||
|
||||
Creates a new container from the image with id "4179ed"
|
||||
Creates a new container from the image with id "4179ed".
|
||||
## PARAMETERS
|
||||
|
||||
### -CertificateLocation
|
||||
|
|
@ -151,25 +147,6 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Id
|
||||
The Id of the image to create the new container from.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: ImageName
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Image
|
||||
The image to create the new container from.
|
||||
|
||||
|
|
@ -229,7 +206,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Name
|
||||
{{Fill Name Description}}
|
||||
The name for the new container.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -244,7 +221,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Terminal
|
||||
Specifies to provide an interactive terminal in the new container.
|
||||
Enables terminal emulation in the new container.
|
||||
|
||||
|
||||
|
||||
|
|
@ -262,6 +239,21 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ImageIdOrName
|
||||
The Name or Id for the image to create the new container from.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: ImageName, ImageId
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### CommonParameters
|
||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
## INPUTS
|
||||
|
|
@ -277,7 +269,7 @@ Docker.DotNet.Models.ImagesListResponse[]
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:]()
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/New-Container.md)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,8 @@ schema: 2.0.0
|
|||
|
||||
# New-ContainerImage
|
||||
## SYNOPSIS
|
||||
New-ContainerImage \[\[-Path\] \<string\>\] \[-Repository \<string\>\] \[-Tag \<string\>\] \[-SkipCache\] \[-ForceRemoveIntermediateContainers\] \[-PreserveIntermediateContainers\] \[-HostAddress \<string\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
Builds a new container image from a set of instructions in a Dockerfile.
|
||||
Aliased as "Build-ContainerImage".
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
|
|
@ -15,7 +16,8 @@ New-ContainerImage [[-Path] <String>] [-Repository <String>] [-Tag <String>] [-I
|
|||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Creates a new container image from an existing container.
|
||||
Builds a new container image from a set of instructions in a Dockerfile.
|
||||
Aliased as "Build-ContainerImage".
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
|
|
@ -23,7 +25,14 @@ Creates a new container image from an existing container.
|
|||
PS C:\> New-ContainerImage
|
||||
```
|
||||
|
||||
Creates a new container image.
|
||||
Creates a new container image from a Dockerfile in the current folder, "C:\".
|
||||
### Example 2
|
||||
```
|
||||
PS C:\> New-ContainerImage -Path "C:\myData\"
|
||||
```
|
||||
|
||||
Creates a new container image from a Dockerfile in the specified folder, "C:\myData".
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -CertificateLocation
|
||||
|
|
@ -84,7 +93,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Path
|
||||
The location to put the new container image.
|
||||
The location to the folder containing the Dockerfile or a path to a file to use as the Dockerfile. If not specified, the current working directory is used.
|
||||
|
||||
|
||||
|
||||
|
|
@ -122,7 +131,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Repository
|
||||
Specifies a repository.
|
||||
Specifies the repository for the new image.
|
||||
|
||||
|
||||
|
||||
|
|
@ -160,7 +169,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Tag
|
||||
Sets a tag for the new image. If no tag is specified, the image will be tagged ":latest".
|
||||
Sets a tag for the new image. If no tag is specified, the image will be tagged "latest".
|
||||
|
||||
|
||||
|
||||
|
|
@ -179,7 +188,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Isolation
|
||||
The isolation level of any resulting containers.
|
||||
The isolation level used for containers during the build.
|
||||
|
||||
```yaml
|
||||
Type: IsolationType
|
||||
|
|
@ -207,7 +216,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:]()
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/New-ContainerImage.md)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ schema: 2.0.0
|
|||
|
||||
# New-ContainerNet
|
||||
## SYNOPSIS
|
||||
{{Fill in the Synopsis}}
|
||||
Creates a new network.
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
|
|
@ -17,19 +17,28 @@ New-ContainerNet [-HostAddress <String>] [-CertificateLocation <String>] [[-Name
|
|||
```
|
||||
|
||||
## DESCRIPTION
|
||||
{{Fill in the Description}}
|
||||
Creates a new network.
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> {{ Add example code here }}
|
||||
PS C:\> New-ContainerNet -Name myNet -Driver transparent
|
||||
```
|
||||
|
||||
{{ Add example description here }}
|
||||
Creates a new transparent network endpoing called "myNet".
|
||||
### Example 2
|
||||
```
|
||||
PS C:\> $opt = New-Object 'System.Collections.Generic.Dictionary[String,String]'
|
||||
PS C:\> $opt.add("com.docker.network.windowsshim.interface","Virtual Switch")
|
||||
PS C:\> New-ContainerNet -Name externalNet -Driver transparent -Options $opt
|
||||
```
|
||||
|
||||
Creates a new transparent network called "externalNet" that is connected to the
|
||||
Hyper-V switch named "Virtual Switch".
|
||||
## PARAMETERS
|
||||
|
||||
### -CertificateLocation
|
||||
{{Fill CertificateLocation Description}}
|
||||
The location of the X509 certificate file named "key.pfx" that will be used for authentication with the server. (Note that certificate authorization work is still in progress and this is likely to change).
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -44,7 +53,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -CheckDuplicate
|
||||
{{Fill CheckDuplicate Description}}
|
||||
Requests that the daemon check for networks with the same name.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
|
|
@ -59,7 +68,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Driver
|
||||
{{Fill Driver Description}}
|
||||
The name of the network driver plugin to use. If not specified, uses the default configured on the daemon.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -74,7 +83,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -EnableIPv6
|
||||
{{Fill EnableIPv6 Description}}
|
||||
Enables IPv6 support on the network.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
|
|
@ -89,7 +98,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -HostAddress
|
||||
{{Fill HostAddress Description}}
|
||||
The address of the docker daemon to connect to.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -104,7 +113,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -IPAM
|
||||
{{Fill IPAM Description}}
|
||||
A Docker.DotNet.Models.IPAM object containing optional custom IP scheme settings for the network.
|
||||
|
||||
```yaml
|
||||
Type: IPAM
|
||||
|
|
@ -119,7 +128,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Internal
|
||||
{{Fill Internal Description}}
|
||||
If specified, external access to the network will be restricted.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
|
|
@ -134,7 +143,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Labels
|
||||
{{Fill Labels Description}}
|
||||
A dictionary containing labels to set on the network.
|
||||
|
||||
```yaml
|
||||
Type: System.Collections.Generic.IDictionary`2[System.String,System.String]
|
||||
|
|
@ -149,7 +158,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Name
|
||||
{{Fill Name Description}}
|
||||
The network name to use.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -164,7 +173,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Options
|
||||
{{Fill Options Description}}
|
||||
A dictionary containing driver specific network options.
|
||||
|
||||
```yaml
|
||||
Type: System.Collections.Generic.IDictionary`2[System.String,System.String]
|
||||
|
|
@ -192,3 +201,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/New-ContainerNet.md)
|
||||
|
|
|
|||
|
|
@ -5,15 +5,13 @@ schema: 2.0.0
|
|||
|
||||
# Remove-Container
|
||||
## SYNOPSIS
|
||||
Remove-Container \[-Id\] \<string\[\]\> \[-Force\] \[-HostAddress \<string\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
|
||||
Remove-Container \[-Container\] \<ContainerListResponse\[\]\> \[-Force\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
Removes a container.
|
||||
## SYNTAX
|
||||
|
||||
### Default (Default)
|
||||
```
|
||||
Remove-Container [-Force] [-Id] <String[]> [-HostAddress <String>] [-CertificateLocation <String>]
|
||||
[<CommonParameters>]
|
||||
Remove-Container [-Force] [-ContainerIdOrName] <String[]> [-HostAddress <String>]
|
||||
[-CertificateLocation <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### ContainerObject
|
||||
|
|
@ -28,7 +26,7 @@ Removes a container.
|
|||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> Remove-Container -id 514e
|
||||
PS C:\> Remove-Container -ContainerIdOrName 514e
|
||||
```
|
||||
|
||||
Removes the container with id "514e"
|
||||
|
|
@ -110,17 +108,13 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Id
|
||||
The id of the container to be removed.
|
||||
|
||||
|
||||
|
||||
|
||||
### -ContainerIdOrName
|
||||
An array of names or ids of the containers to be removed.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: Name
|
||||
Aliases: Name, Id
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
|
|
@ -143,7 +137,7 @@ Docker.DotNet.Models.ContainerListResponse[]
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:]()
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Remove-Container.md)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -5,15 +5,13 @@ schema: 2.0.0
|
|||
|
||||
# Remove-ContainerImage
|
||||
## SYNOPSIS
|
||||
Remove-ContainerImage \[-Id\] \<string\[\]\> \[-Force\] \[-HostAddress \<string\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
|
||||
Remove-ContainerImage \[-Image\] \<ImagesListResponse\[\]\> \[-Force\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
Removes a container image.
|
||||
## SYNTAX
|
||||
|
||||
### Default (Default)
|
||||
```
|
||||
Remove-ContainerImage [-Force] [-Id] <String[]> [-HostAddress <String>] [-CertificateLocation <String>]
|
||||
[<CommonParameters>]
|
||||
Remove-ContainerImage [-Force] [-ImageIdOrName] <String[]> [-HostAddress <String>]
|
||||
[-CertificateLocation <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### ImageObject
|
||||
|
|
@ -28,7 +26,7 @@ Removes a container image.
|
|||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> Remove-ContainerImage -id 124dfe
|
||||
PS C:\> Remove-ContainerImage -ImageIdOrName 124dfe
|
||||
```
|
||||
|
||||
Removes the container with id "124dfe"
|
||||
|
|
@ -91,25 +89,6 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Id
|
||||
The id of the image to be removed.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: ImageName
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Image
|
||||
The image that is to be removed.
|
||||
|
||||
|
|
@ -129,6 +108,21 @@ Accept pipeline input: True (ByValue)
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ImageIdOrName
|
||||
The Name or Id for the image to be removed.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: ImageName, ImageId
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### CommonParameters
|
||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
## INPUTS
|
||||
|
|
@ -143,7 +137,7 @@ Docker.DotNet.Models.ImagesListResponse[]
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:]()
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Remove-ContainerImage.md)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ schema: 2.0.0
|
|||
|
||||
# Remove-ContainerNet
|
||||
## SYNOPSIS
|
||||
{{Fill in the Synopsis}}
|
||||
Removes a network endpoint.
|
||||
## SYNTAX
|
||||
|
||||
### Default (Default)
|
||||
|
|
@ -22,19 +22,19 @@ Remove-ContainerNet [-Force] [-Network] <NetworkListResponse[]> [-HostAddress <S
|
|||
```
|
||||
|
||||
## DESCRIPTION
|
||||
{{Fill in the Description}}
|
||||
Removes a network endpoint.
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> {{ Add example code here }}
|
||||
PS C:\> Remove-ContainerNet -Id "Virtual Switch"
|
||||
```
|
||||
|
||||
{{ Add example description here }}
|
||||
Removes the network endpoint named "Virtual Switch"
|
||||
## PARAMETERS
|
||||
|
||||
### -CertificateLocation
|
||||
{{Fill CertificateLocation Description}}
|
||||
The location of the X509 certificate file named "key.pfx" that will be used for authentication with the server. (Note that certificate authorization work is still in progress and this is likely to change).
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -49,7 +49,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Force
|
||||
{{Fill Force Description}}
|
||||
Completes the operation without prompting for confirmation.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
|
|
@ -64,7 +64,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -HostAddress
|
||||
{{Fill HostAddress Description}}
|
||||
The address of the docker daemon to connect to.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -79,7 +79,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Id
|
||||
{{Fill Id Description}}
|
||||
The name or id of the network endpoint to remove.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
|
|
@ -94,7 +94,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Network
|
||||
{{Fill Network Description}}
|
||||
The network endpont to remove.
|
||||
|
||||
```yaml
|
||||
Type: NetworkListResponse[]
|
||||
|
|
@ -122,3 +122,4 @@ Docker.DotNet.Models.NetworkListResponse[]
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Remove-ContainerNet.md)
|
||||
|
|
|
|||
|
|
@ -7,6 +7,7 @@ schema: 2.0.0
|
|||
# Request-ContainerImage
|
||||
## SYNOPSIS
|
||||
Downloads a container image matching the given repository and tag from the Docker registry.
|
||||
Aliased as "Pull-ContainerImage".
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
|
|
@ -16,14 +17,15 @@ Request-ContainerImage [-Repository] <String> [[-Tag] <String>] [-All] [-Authori
|
|||
|
||||
## DESCRIPTION
|
||||
Downloads a container image matching the given repository and tag from the Docker registry.
|
||||
Aliased as "Pull-ContainerImage".
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> {{ Add example code here }}
|
||||
PS C:\> Request-ContainerImage -Repository "microsoft/nanoserver"
|
||||
```
|
||||
|
||||
{{ Add example description here }}
|
||||
Pulls the latest image from the repository "microsoft/nanoserver".
|
||||
## PARAMETERS
|
||||
|
||||
### -All
|
||||
|
|
@ -42,7 +44,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Authorization
|
||||
A Docker.DotNet.Models.AuthConfig object containing authentication information for the connection to the Docker registry being pushed to.
|
||||
A Docker.DotNet.Models.AuthConfig object containing authentication information for the connection to the Docker registry being pulled from.
|
||||
|
||||
```yaml
|
||||
Type: AuthConfig
|
||||
|
|
@ -102,7 +104,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Tag
|
||||
The tag for which image to download.
|
||||
The tag specifying the image to download. If not provided, the "latest" image is pulled.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
|
|
@ -130,3 +132,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Request-ContainerImage.md)
|
||||
|
|
|
|||
|
|
@ -5,14 +5,12 @@ schema: 2.0.0
|
|||
|
||||
# Start-Container
|
||||
## SYNOPSIS
|
||||
Start-Container \[-Id\] \<string\[\]\> \[-PassThru\] \[-HostAddress \<string\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
|
||||
Start-Container \[-Container\] \<ContainerListResponse\[\]\> \[-PassThru\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
Starts a container.
|
||||
## SYNTAX
|
||||
|
||||
### Default (Default)
|
||||
```
|
||||
Start-Container [-Attach] [-Input] [-PassThru] [-Id] <String[]> [-HostAddress <String>]
|
||||
Start-Container [-Attach] [-Input] [-PassThru] [-ContainerIdOrName] <String[]> [-HostAddress <String>]
|
||||
[-CertificateLocation <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
|
|
@ -23,7 +21,7 @@ Start-Container [-Attach] [-Input] [-PassThru] [-Container] <ContainerListRespon
|
|||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Starts a container
|
||||
Starts a container.
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
|
|
@ -31,11 +29,11 @@ Starts a container
|
|||
PS C:\> Start-Container $myContainer
|
||||
```
|
||||
|
||||
Starts a container
|
||||
Starts a container.
|
||||
## PARAMETERS
|
||||
|
||||
### -CertificateLocation
|
||||
Cert location
|
||||
The location of the X509 certificate file named "key.pfx" that will be used for authentication with the server. (Note that certificate authorization work is still in progress and this is likely to change).
|
||||
|
||||
|
||||
|
||||
|
|
@ -54,7 +52,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Container
|
||||
The container to start
|
||||
The container to start.
|
||||
|
||||
|
||||
|
||||
|
|
@ -91,27 +89,8 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Id
|
||||
Id of the container to start. Can be a unique subset of ID.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: Name
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -PassThru
|
||||
Passes the new container object through the pipeline.
|
||||
Passes the started container object through the pipeline.
|
||||
|
||||
|
||||
|
||||
|
|
@ -145,7 +124,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Input
|
||||
If set directs STDIN.
|
||||
Indicates that the stdin of the container should be kept open.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
|
|
@ -159,6 +138,21 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ContainerIdOrName
|
||||
The Id or Name of the container to start.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: Name, Id
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### CommonParameters
|
||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
## INPUTS
|
||||
|
|
@ -173,7 +167,7 @@ Docker.DotNet.Models.ContainerListResponse[]
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/tree/master/src/Docker.PowerShell/en-us/)
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Start-Container.md)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -6,15 +6,14 @@ schema: 2.0.0
|
|||
|
||||
# Start-ContainerProcess
|
||||
## SYNOPSIS
|
||||
Start-ContainerProcess \[-Id\] \<string\[\]\> \[\[-Command\] \<string\[\]\>\] \[-Detached\] \[-TTY\] \[-Privileged\] \[-User \<string\[\]\>\]\[-HostAddress \<string\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
|
||||
Start-ContainerProcess \[-Container\] \<ContainerListResponse\[\]\> \[\[-Command\] \<string\[\]\>\] \[-Detached\] \[-TTY\] \[-Privileged\] \[-User \<string\[\]\>\]\[-HostAddress \<string\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
Starts a new process with the given command in the specified container.
|
||||
Aliased as "Exec-Container".
|
||||
## SYNTAX
|
||||
|
||||
### Default (Default)
|
||||
```
|
||||
Start-ContainerProcess [[-Command] <String[]>] [-Detached] [-Input] [-Terminal] [-Privileged] [-User <String>]
|
||||
[-Id] <String> [-HostAddress <String>] [-CertificateLocation <String>] [<CommonParameters>]
|
||||
[-ContainerIdOrName] <String> [-HostAddress <String>] [-CertificateLocation <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### ContainerObject
|
||||
|
|
@ -26,14 +25,15 @@ Start-ContainerProcess [[-Command] <String[]>] [-Detached] [-Input] [-Terminal]
|
|||
|
||||
## DESCRIPTION
|
||||
Starts a new process with the given command in the specified container.
|
||||
Aliased as "Exec-Container".
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> {{ Add example code here }}
|
||||
PS C:\> Start-ContainerProcess -ContainerIdOrName myContainer -Command "c:\myTest.exe"
|
||||
```
|
||||
|
||||
{{ Add example description here }}
|
||||
Starts the command "c:\myTest.exe" in the container named "myContainer".
|
||||
## PARAMETERS
|
||||
|
||||
### -CertificateLocation
|
||||
|
|
@ -82,7 +82,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Detached
|
||||
If specified, just the container process object will be returned and the process will run asynchronously.
|
||||
If specified, just the container process object will be returned and the process will run asynchronously. Otherwise, STDOUT/STDERR will be connected and output of the command will be displayed.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
|
|
@ -111,21 +111,6 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Id
|
||||
The identifier for the container in which the process will be started.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Default
|
||||
Aliases: Name
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Privileged
|
||||
If specified, the process will be started in privileged mode.
|
||||
|
||||
|
|
@ -172,7 +157,7 @@ Accept wildcard characters: False
|
|||
```
|
||||
|
||||
### -Input
|
||||
Indicates that the stdin of the process should be kept open.
|
||||
Indicates that the STDIN of the process should be kept open.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
|
|
@ -186,6 +171,21 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ContainerIdOrName
|
||||
The Id or Name of the container to start the command in.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Default
|
||||
Aliases: Name, Id
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### CommonParameters
|
||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
## INPUTS
|
||||
|
|
@ -201,3 +201,4 @@ Docker.DotNet.Models.ContainerListResponse
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Start-ContainerProcess.md)
|
||||
|
|
|
|||
|
|
@ -5,15 +5,13 @@ schema: 2.0.0
|
|||
|
||||
# Stop-Container
|
||||
## SYNOPSIS
|
||||
Stop-Container \[-Id\] \<string\[\]\> \[-Force\] \[-PassThru\] \[-HostAddress \<string\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
|
||||
Stop-Container \[-Container\] \<ContainerListResponse\[\]\> \[-Force\] \[-PassThru\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
Stops a running container.
|
||||
## SYNTAX
|
||||
|
||||
### Default (Default)
|
||||
```
|
||||
Stop-Container [-Force] [-PassThru] [-Id] <String[]> [-HostAddress <String>] [-CertificateLocation <String>]
|
||||
[<CommonParameters>]
|
||||
Stop-Container [-Force] [-PassThru] [-ContainerIdOrName] <String[]> [-HostAddress <String>]
|
||||
[-CertificateLocation <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### ContainerObject
|
||||
|
|
@ -28,10 +26,10 @@ Stops a running container.
|
|||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> Stop-Container myContainer
|
||||
PS C:\> Stop-Container -ContainerIdOrName myContainer
|
||||
```
|
||||
|
||||
Stops the container myContainer
|
||||
Stops the container named "myContainer".
|
||||
## PARAMETERS
|
||||
|
||||
### -CertificateLocation
|
||||
|
|
@ -110,25 +108,6 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Id
|
||||
The id of the container to be stopped.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: Name
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -PassThru
|
||||
Passes the stopped container through the pipeline.
|
||||
|
||||
|
|
@ -148,6 +127,21 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ContainerIdOrName
|
||||
The Id or Name of the container to stop.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: Name, Id
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### CommonParameters
|
||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
## INPUTS
|
||||
|
|
@ -162,7 +156,7 @@ Docker.DotNet.Models.ContainerListResponse[]
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/)
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Stop-Container.md)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -7,12 +7,13 @@ schema: 2.0.0
|
|||
# Submit-ContainerImage
|
||||
## SYNOPSIS
|
||||
Submits the container image by pushing it to a Docker registry.
|
||||
Aliased as "Push-ContainerImage".
|
||||
## SYNTAX
|
||||
|
||||
### Default (Default)
|
||||
```
|
||||
Submit-ContainerImage [-Id] <String> [-PassThru] [-Authorization <AuthConfig>] [-HostAddress <String>]
|
||||
[-CertificateLocation <String>] [<CommonParameters>]
|
||||
Submit-ContainerImage [-ImageIdOrName] <String> [-PassThru] [-Authorization <AuthConfig>]
|
||||
[-HostAddress <String>] [-CertificateLocation <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### ImageObject
|
||||
|
|
@ -23,14 +24,15 @@ Submit-ContainerImage [-Image] <ImagesListResponse> [-PassThru] [-Authorization
|
|||
|
||||
## DESCRIPTION
|
||||
Submits the container image by pushing it to a Docker registry.
|
||||
Aliased as "Push-ContainerImage".
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> {{ Add example code here }}
|
||||
PS C:\> Submit-ContainerImage -ImageIdOrName myImage
|
||||
```
|
||||
|
||||
{{ Add example description here }}
|
||||
Pushes the image named "myImage" to the Docker registry.
|
||||
## PARAMETERS
|
||||
|
||||
### -Authorization
|
||||
|
|
@ -78,23 +80,8 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Id
|
||||
The id of the container image.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Default
|
||||
Aliases: ImageName
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Image
|
||||
Specifies the container image object.
|
||||
Specifies the container image object to be pushed.
|
||||
|
||||
```yaml
|
||||
Type: ImagesListResponse
|
||||
|
|
@ -123,6 +110,21 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ImageIdOrName
|
||||
The Id or Name of the image to be pushed.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Default
|
||||
Aliases: ImageName, ImageId
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### CommonParameters
|
||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
## INPUTS
|
||||
|
|
@ -137,3 +139,4 @@ Docker.DotNet.Models.ImagesListResponse
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Submit-ContainerImage.md)
|
||||
|
|
|
|||
|
|
@ -5,15 +5,13 @@ schema: 2.0.0
|
|||
|
||||
# Wait-Container
|
||||
## SYNOPSIS
|
||||
Wait-Container \[-Id\] \<string\[\]\> \[-PassThru\] \[-HostAddress \<string\>\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
|
||||
Wait-Container \[-Container\] \<ContainerListResponse\[\]\> \[-PassThru\] \[-CertificateLocation \<string\>\] \[\<CommonParameters\>\]
|
||||
Waits for the given container to shutdown, often indicating that the process run inside the container has completed.
|
||||
## SYNTAX
|
||||
|
||||
### Default (Default)
|
||||
```
|
||||
Wait-Container [-PassThru] [-Id] <String[]> [-HostAddress <String>] [-CertificateLocation <String>]
|
||||
[<CommonParameters>]
|
||||
Wait-Container [-PassThru] [-ContainerIdOrName] <String[]> [-HostAddress <String>]
|
||||
[-CertificateLocation <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### ContainerObject
|
||||
|
|
@ -28,7 +26,7 @@ Waits for the given container to shutdown, often indicating that the process run
|
|||
|
||||
### Example 1
|
||||
```
|
||||
PS C:\> Wait-Container -id 1512f
|
||||
PS C:\> Wait-Container -ContainerIdOrName 1512f
|
||||
```
|
||||
|
||||
Waits for the container "1521f" to shut down.
|
||||
|
|
@ -91,25 +89,6 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Id
|
||||
The id of the container.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: Name
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -PassThru
|
||||
Passes the container object through the pipeline.
|
||||
|
||||
|
|
@ -129,6 +108,21 @@ Accept pipeline input: False
|
|||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ContainerIdOrName
|
||||
The Id or Name of the container to wait for.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default
|
||||
Aliases: Name, Id
|
||||
|
||||
Required: True
|
||||
Position: 0
|
||||
Default value: None
|
||||
Accept pipeline input: True (ByValue)
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### CommonParameters
|
||||
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
## INPUTS
|
||||
|
|
@ -143,7 +137,7 @@ Docker.DotNet.Models.ContainerListResponse[]
|
|||
|
||||
## RELATED LINKS
|
||||
|
||||
[Online Version:]()
|
||||
[Online Version:](https://github.com/Microsoft/Docker-PowerShell/blob/master/src/Docker.PowerShell/Help/Wait-Container.md)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче