Export-PfxCertificate
Export-PfxCertificate
Exports a certificate or a PFXData object to a Personal Information Exchange (PFX) file.
構文
Parameter Set: NormalCert
Export-PfxCertificate [-Cert] <Certificate> [-FilePath] <String> [-ChainOption <ExportChainOption> {BuildChain | EndEntityCertOnly | PfxDataOnly} ] [-Force] [-NoClobber] [-NoProperties] [-Password <SecureString> ] [-ProtectTo <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: PfxCert
Export-PfxCertificate [-PFXData] <PfxData> [-FilePath] <String> [-ChainOption <ExportChainOption> {BuildChain | EndEntityCertOnly | PfxDataOnly} ] [-Force] [-NoClobber] [-NoProperties] [-Password <SecureString> ] [-ProtectTo <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
詳細説明
The Export-PfxCertificate cmdlet exports a certificate or a PFXData object to a Personal Information Exchange (PFX) file. By default, extended properties and the entire chain are exported.
Delegation may be required when using this cmdlet with Windows PowerShell® remoting and changing user configuration.
パラメーター
-Cert<Certificate>
Specifies the path to the certificate to be exported.
Aliases |
PsPath |
必須/オプション |
true |
位置 |
1 |
既定値 |
none |
パイプライン入力の受け入れ |
true (ByPropertyName) |
ワイルドカード文字の受け入れ |
false |
-ChainOption<ExportChainOption>
Specifies the options for building a chain when exporting certificates. このパラメーターに指定できる値は、次のとおりです。
-- BuildChain: Certificate chain for all end entity certificates will be built and included in the export. This option is valid for both PfxData and Cert parameters. In the case of PfxData parameter, the collection of all PFX certificates will be used as an additional store.
-- EndEntityCertOnly: Only end entity certificates are exported without any chain. This option is valid for both the PfxData and the Cert parameters.
-- PfxDataOnly: Certificates contained in PFXData objects will be exported with no chain building. This option is only valid when the PfxData parameter is used.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-FilePath<String>
Specifies the path for the PFX file to be exported.
Aliases |
none |
必須/オプション |
true |
位置 |
2 |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-Force
Specifies that the provided PFX file should be overwritten, even if the Read-only attribute is set on the file. By default, this cmdlet overwrites existing PFX files without warning, unless the Read-only or hidden attribute is set or the NoClobber parameter is used in the cmdlet.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-NoClobber
Specifies that if the PFX file already exists, it should not be over written. This parameter takes precedence over the Force parameter, which permits this cmdlet to overwrite a PFX file even if it has the Read-only attribute set.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-NoProperties
Specifies whether the extended properties for a certificate are exported. If this parameter is specified, then extended properties are not included with the export. By default, all extended properties are included in the exported file.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-PFXData<PfxData>
Specifies a PFXData object that contains one or more certificates from a PFX file.
Aliases |
none |
必須/オプション |
true |
位置 |
1 |
既定値 |
none |
パイプライン入力の受け入れ |
true (ByValue) |
ワイルドカード文字の受け入れ |
false |
-Password<SecureString>
Specifies the password used to protect the exported PFX file. The password should be in the form of secure string. Either the ProtectTo or this parameter must be specified, or an error will be displayed.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-ProtectTo<String[]>
Specifies an array of strings for the username or group name that can access the private key of PFX file without any password. This requires a Windows Server® 2012 domain controller. Either the Password or this parameter must be specified, or an error will be displayed.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
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) を参照してください。
入力
入力型は、コマンドレットにパイプできるオブジェクトの型です。
System.Security.Cryptography.X509Certificates.X509Certificate2[]
The X509Certificate2[] object is an array of certificate objects.
出力
出力型は、コマンドレットが出力するオブジェクトの型です。
System.IO.FileInfo
The FileInfo object contains the information about the PFX file.
使用例
EXAMPLE 1
This example exports a certificate from the local machine store to a PFX file which includes the entire chain and all external properties.
PS C:\> $mypwd = ConvertTo-SecureString -String "1234" -Force –AsPlainText
PS C:\> Get-ChildItem -Path cert:\localMachine\my\5F98EBBFE735CDDAE00E33E0FD69050EF9220254 | Export-PfxCertificate -FilePath C:\mypfx.pfx -Password $mypwd
EXAMPLE 2
This example exports all certificates under the My store for the machine account into one file named mypfx.pfx. In order for this cmdlet to succeed, all keys need to be exportable.
PS C:\> $mypwd = ConvertTo-SecureString -String "1234" -Force –AsPlainText
PS C:\> Get-ChildItem -Path cert:\LocalMachine\my | Export-PfxCertificate -FilePath C:\mypfx.pfx -Password $mypwd
EXAMPLE 3
This example exports a certificate from the current user store with no chain and no external properties
PS C:\> $mypwd = ConvertTo-SecureString -String "1234" -Force –AsPlainText
PS C:\> Export-PfxCertificate –Cert cert:\currentuser\my\5F98EBBFE735CDDAE00E33E0FD69050EF9220254 –FilePath c:\myexport.pfx -ChainOption EndEntityCertOnly -NoProperties -Password $mypwd
EXAMPLE 4
This example exports a certificate from the current machine store. Both user accounts, contos\billb99 and contos\johnj99, can access this PFX with no password. A Windows® 8 DC for key distribution is required.
PS C:\> $a = Get-ChildItem -Path cert:\localMachine\my
Export-PfxCertificate –Cert $a[1] –FilePath C:\myexport.pfx -ProtectTo "contoso\billb99, contoso\johnj99"
EXAMPLE 5
This example exports a certificate from the current machine store. Both user accounts, johnj99 and billb99, can access this PFX file with no password. For everyone else, they need to use 1234 as a password. A Windows 8 DC for key distribution is required.
PS C:\> $a = Get-ChildItem -Path cert:\localMachine\my
PS C:\> $mypwd = ConvertTo-SecureString -String "1234" -Force –AsPlainText
PS C:\> Export-PfxCertificate –Cert $a[1] –FilePath C:\myexport.pfx -ProtectTo "contoso\billb99, contoso\johnj99" -Password $mypwd
EXAMPLE 6
This example changes an existing password for a PFX file from $OldPwd to $NewPwd.
PS C:\> $NewPwd = ConvertTo-SecureString -String "abcd" -Force –AsPlainText
PS C:\> $mypfx = Get-PfxData –FilePath C:\mypfx.pfx -Password $Oldpwd
PS C:\> Export-PfxCertificate -PFXData $mypfx –FilePath C:\mypfx2.pfx -Password $NewPwd