Export-ContainerImage
Export-ContainerImage
Exports a container image to a file.
構文
Parameter Set: Container Image Object
Export-ContainerImage [-Image] <ContainerImage[]> [-Path] <String> [-AsJob] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: Name
Export-ContainerImage [[-Name] <String> ] [-Path] <String> [[-Publisher] <String> ] [[-Version] <Version> ] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String[]> ] [-Credential <PSCredential[]> ] [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]
詳細説明
The Export-ContainerImage cmdlet exports a container image to a file.
パラメーター
-AsJob
Indicates that this cmdlet runs the command as a background job on a remote computer. Use this parameter to run commands that take an extensive time to complete.
When you use AsJob, the command returns an object that represents the job, and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the Job cmdlets. To get the job results, use the Receive-Job cmdlet.
For more information about Windows PowerShell background jobs, see about_Jobs (https://go.microsoft.com/fwlink/?LinkID=113251) and about_Remote_Jobs (https://go.microsoft.com/fwlink/?LinkID=135184).
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-CimSession<CimSession[]>
リモート セッションまたはリモート コンピューターでコマンドレットを実行します。コンピューター名またはセッション オブジェクト (New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など) を入力します。既定値は、ローカル コンピューター上の現在のセッションです。
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-ComputerName<String[]>
Specifies one or more Hyper-V hosts to run the cmdlet. NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer. Use "localhost" or a dot (".") to specify the local computer explicitly.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-Credential<PSCredential[]>
Specifies a user account that has permission to perform this action. The default is the current user.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-Image<ContainerImage[]>
Specifies the container image to be exported.
Aliases |
none |
必須/オプション |
true |
位置 |
1 |
既定値 |
none |
パイプライン入力の受け入れ |
true(ByValue) |
ワイルドカード文字の受け入れ |
false |
-Name<String>
Specifies the name of the container image that this cmdlet exports.
Aliases |
none |
必須/オプション |
false |
位置 |
1 |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-Passthru
作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットから出力は生成されません。
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-Path<String>
Specfies the path to which this cmdlet exports the image.
Aliases |
none |
必須/オプション |
true |
位置 |
2 |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-Publisher<String>
Specifies the publisher of the container image that this cmdlet exports.
Aliases |
none |
必須/オプション |
false |
位置 |
2 |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-Version<Version>
Specifies the version of the container image that this cmdlet exports.
Aliases |
none |
必須/オプション |
false |
位置 |
3 |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-Confirm
コマンドレットを実行する前に確認メッセージを表示します。
必須/オプション |
false |
位置 |
named |
既定値 |
false |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-WhatIf
コマンドレットが実行された場合に何が起きるのかを示します。コマンドレットは実行されません。
必須/オプション |
false |
位置 |
named |
既定値 |
false |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
<CommonParameters>
このコマンドレットは共通のパラメーターをサポートしています(-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable)。詳細については、TechNet の「 「about_CommonParameters」 (https://go.microsoft.com/fwlink/p/?LinkID=113216) を参照してください。
入力
入力型は、コマンドレットにパイプできるオブジェクトの型です。
出力
出力型は、コマンドレットが出力するオブジェクトの型です。
Microsoft.Containers.PowerShell.Objects.ContainerImage
Microsoft.Containers.PowerShell.Objects.ContainerImage
使用例
Example 1: Export a container image
This command exports the container image stored in the $Image01 variable to the path C:\Containers.
PS C:\> Export-ContainerImage -Image $Image01 -Path "C:\Containers"