Export-SPCertificate

リファレンス

モジュール:: sharepoint-server

SharePoint ファームから証明書をエクスポートします。

構文

Export-SPCertificate
      [-Identity] <SPServerCertificatePipeBind>
      -Password <SecureString>
      [-EncryptionType <String>]
      [-IncludeAllCertificatesInCertificationPath]
      [-NoExtendedProperties]
      [-Path <String>]
      [-Force]
      [-AssignmentCollection <SPAssignmentCollection>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Export-SPCertificate
      [-Identity] <SPServerCertificatePipeBind>
      -Type <String>
      [-IncludeAllCertificatesInCertificationPath]
      [-Path <String>]
      [-Force]
      [-AssignmentCollection <SPAssignmentCollection>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

SharePoint ファームから証明書ファイルに証明書をエクスポートします。このエクスポートされた証明書ファイルは、既定ではサーバーの全体管理サイトに格納されますが、Path パラメーターで指定されたパスに格納することもできます。

SharePoint では、PFX (PKCS #12) ファイル、P7B (PKCS #7) ファイル、CER ファイルへの証明書のエクスポートがサポートされています。 PFX ファイルと P7B ファイルの両方に複数の証明書を含めることができます。これは、エンドエンティティ (リーフ) 証明書からルート証明書に証明書のチェーンをエクスポートする場合に便利です。ただし、証明書の秘密キーを含めることができるのは PFX ファイルのみです。これは、サーバー証明書を IIS Web サイトに割り当てるために必要です。 CER ファイルに含まれる証明書は 1 つだけです。

例

------------EXAMPLE 1-----------

$password = ConvertTo-SecureString -AsPlainText -Force 
 
Export-SPCertificate -Identity "Team Sites Certificate" -Password $password -IncludeAllCertificatesInCertificationPath -Path "\\server\fileshare\certificates.pfx"

この例では、"Team Sites 証明書" 証明書とその秘密キー、およびその証明書チェーン内の他の証明書を \\server\fileshare\certificates.pfx ファイルにエクスポートします。

------------EXAMPLE 2-----------

Export-SPCertificate -Identity "Team Sites Certificate" -Type Cert

次の使用例は、サーバーの全体管理に格納されている証明書ファイルに "Team Sites 証明書" 証明書をエクスポートします。

パラメーター

-AssignmentCollection

適切な破棄を行うためにオブジェクトを管理します。 SPWeb や SPSite などのオブジェクトの使用によって大量のメモリが使用される場合があるので、Windows PowerShell スクリプトでこれらのオブジェクトを使用するには適切なメモリ管理が必要です。メモリの解放が必要になった場合は、SPAssignment オブジェクトを使用して、変数へのオブジェクトの割り当てとオブジェクトの破棄を行うことができます。割り当てコレクションまたは Global パラメーターが使用されていない場合、SPWeb、SPSite、または SPSiteAdministration オブジェクトが使用されていると、オブジェクトは自動的に破棄されます。

Global パラメーターが使用されている場合は、オブジェクトはすべてグローバルストアに格納されます。 Stop-SPAssignment コマンドを使用してオブジェクトの使用または破棄を直接行わないと、メモリ不足のシナリオになる場合があります。

Type:	SPAssignmentCollection
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Confirm

コマンドレットを実行する前に確認メッセージを表示します。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EncryptionType

エクスポートされた PFX ファイルを保護するために使用する暗号化アルゴリズムを指定します。 AES256 は、SHA256 ハッシュを使用した AES-256 暗号化を使用することを指定します。 TripleDes は、SHA1 ハッシュを使用した 3DES 暗号化を使用することを指定します。 AES-256 暗号化は 3DES 暗号化よりも強力ですが、Windows Server 2019 以降のオペレーティングシステム上の PFX ファイルでのみサポートされます。 PFX ファイルが古いオペレーティングシステムと互換性がある必要がある場合は、3DES 暗号化を使用します。このパラメーターが指定されていない場合、AES-256 暗号化が既定で使用されます。このパラメーターは PFX ファイルとのみ互換性があります。

Type:	String
Accepted values:	AES256, TripleDes
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

指定したパスに既に存在するファイルを上書きすることを指定します。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Identity

エクスポートする証明書。

Type:	SPServerCertificatePipeBind
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-IncludeAllCertificatesInCertificationPath

指定した証明書の証明書チェーンの一部である追加の証明書をエクスポートするかどうかを指定します。これにより、指定した証明書によって発行された子証明書ではなく、指定した証明書の親証明書のみが追加されます。このパラメーターは、PFX および P7B ファイルとのみ互換性があります。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NoExtendedProperties

証明書のフレンドリ名など、証明書の拡張プロパティをエクスポートしないかどうかを指定します。このパラメーターは PFX ファイルとのみ互換性があります。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Password

エクスポートされた PFX ファイルを保護するために使用するパスワード。このパラメーターは PFX ファイルとのみ互換性があります。

Type:	SecureString
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

証明書をエクスポートする必要がある PFX、P7B、または CER ファイルへのパス。

証明書は、このパラメーターが指定されているかどうかに関係なく、サーバーの全体管理に格納されている証明書ファイルにもエクスポートされます。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Type

生成するファイルの種類を指定します。 Cert は、1 つの DER でエンコードされた証明書を含む CER ファイルを生成します。 Pkcs7 は、1 つ以上の証明書を含む P7B (PKCS #7) ファイルを生成します。このパラメーターは、CER および P7B ファイルとのみ互換性があります。

Type:	String
Accepted values:	Cert, Pkcs7
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

コマンドレットが実行されるとどうなるかを示します。コマンドレットは実行されません。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False