Renew-SPCertificate

リファレンス

モジュール:: sharepoint-server

適用対象:: SharePoint Server Subscription Edition

証明書を更新し、新しい証明書署名要求を作成します。

構文

Renew-SPCertificate
     [-Identity] <SPServerCertificatePipeBind>
     -FriendlyName <String>
     [-CommonName <String>]
     [-AlternativeNames <String[]>]
     [-OrganizationalUnit <String>]
     [-Organization <String>]
     [-Locality <String>]
     [-State <String>]
     [-Country <String>]
     [-Exportable]
     [-HashAlgorithm <String>]
     [-Path <String>]
     [-Force]
     [-AssignmentCollection <SPAssignmentCollection>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Renew-SPCertificate
     [-Identity] <SPServerCertificatePipeBind>
     -FriendlyName <String>
     [-CommonName <String>]
     [-AlternativeNames <String[]>]
     [-OrganizationalUnit <String>]
     [-Organization <String>]
     [-Locality <String>]
     [-State <String>]
     [-Country <String>]
     [-Exportable]
     [-KeySize <Int32>]
     [-HashAlgorithm <String>]
     [-Path <String>]
     [-Force]
     [-AssignmentCollection <SPAssignmentCollection>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Renew-SPCertificate
     [-Identity] <SPServerCertificatePipeBind>
     -FriendlyName <String>
     [-CommonName <String>]
     [-AlternativeNames <String[]>]
     [-OrganizationalUnit <String>]
     [-Organization <String>]
     [-Locality <String>]
     [-State <String>]
     [-Country <String>]
     [-Exportable]
     [-EllipticCurve <EllipticCurveType>]
     [-HashAlgorithm <String>]
     [-Path <String>]
     [-Force]
     [-AssignmentCollection <SPAssignmentCollection>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

説明

SharePoint では、Renew-SPCertificate PowerShell コマンドレットを使用した SSL 証明書の更新がサポートされています。これにより、既存の証明書のプロパティに基づいて新しい証明書署名要求が作成され、SSL 証明書を更新するための 3 つの手順の最初の手順です。

操作を介して SSL 証明書要求が作成されたら、SharePoint 管理者は SSL 証明機関に証明書要求を送信する必要があります。 SSL 証明機関は、要求に基づいて署名付き証明書を生成し、SharePoint 管理者に返します。その後、SharePoint 管理者は、SSL 証明機関から提供された証明書を SharePoint にインポートする必要があります。その後、SharePoint は、インポートされた証明書と、証明書要求操作によって生成された秘密キーをペアリングします。その後、証明書を SharePoint で使用する準備が整います。

証明書の更新操作の一部として証明書をインポートする場合は、replace switch パラメーターを Import-SPCertificate コマンドレットで指定できます。これにより、更新される証明書の証明書の割り当てを新しい証明書に自動的に置き換えるよう SharePoint に指示されます。

例

------------ 例 -----------

Renew-SPCertificate -Identity "Sites Certificate (2020)" -FriendlyName "Sites Certificate (2021)" -Exportable -Path "\\server\fileshare\Team Sites Certificate Signing Request.txt"

この例では、証明書を更新し、証明書署名要求を作成します。

パラメーター

-AlternativeNames

この証明書が割り当てられる追加の DNS ドメイン名または IP アドレス。完全修飾ドメイン名 (FQDN) をお勧めします。

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

-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

-CommonName

この証明書が割り当てられるプライマリ DNS ドメイン名または IP アドレス。完全修飾ドメイン名 (FQDN) をお勧めします。

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

-Confirm

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

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

-Country

組織が法的に配置されている 2 文字の国コード。これは ISO 3166-1 alpha-2 国コードである必要があります。このパラメーターを指定しない場合は、ファームの既定の国が使用されます。

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

-EllipticCurve

証明書に楕円曲線暗号化キーアルゴリズムを使用し、パブリック ECC キーとプライベート ECC キーの楕円曲線を使用するように指定します。

楕円曲線が大きいほど、楕円曲線よりも暗号化強度が高くなりますが、計算コストが高くなり、SSL/TLS 接続を完了するのに時間がかかります。使用する楕円曲線がわからない場合は、nistP256 を選択します。 nistP384 より大きい楕円曲線は推奨されません。

このパラメーターも KeySize パラメーターも指定されていない場合は、ファームの既定のキーアルゴリズムとキーサイズ/楕円曲線が使用されます。

Type:	EllipticCurveType
Accepted values:	Default, nistP256, nistP384, nistP521
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Exportable

証明書の秘密キーをエクスポートできるかどうかを指定します。このパラメーターを指定しない場合、SharePoint ファーム内の各サーバー上の Windows 証明書ストアに展開された証明書の秘密キーはエクスポートできません。また、SharePoint では SharePoint 管理インターフェイス内から秘密キーをエクスポートすることはできません。

Type:	SwitchParameter
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

-FriendlyName

証明書のフレンドリ名。この名前は、この証明書の目的を思い出すのに役立ちます。フレンドリ名は SharePoint ファーム管理者にのみ表示され、エンドユーザーには表示されません。

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

-HashAlgorithm

証明書の要求が改ざんされていないことを確認するために証明機関が使用する証明書署名のハッシュアルゴリズムを指定します。

ハッシュアルゴリズムが大きいほど、暗号化強度は小さいハッシュアルゴリズムよりも高くなりますが、計算コストも高くなります。使用するハッシュアルゴリズムがわからない場合は、[SHA256] を選択します。 SHA384 より大きいハッシュアルゴリズムは推奨されません。

このパラメーターを指定しない場合は、ファームの既定のハッシュアルゴリズムが使用されます。

Type:	String
Accepted values:	Default, SHA256, SHA384, SHA512
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:	False
Accept wildcard characters:	False

-KeySize

証明書に RSA キーアルゴリズムを使用し、パブリック RSA キーとプライベート RSA キーのサイズをビット単位で指定します。

キーサイズが大きいほど、暗号化強度は小さいキーサイズよりも高くなりますが、計算コストが高くなり、SSL/TLS 接続を完了するのに時間がかかります。使用するキーサイズがわからない場合は、[2048] を選択します。 4096 より大きいキーサイズは推奨されません。

このパラメーターも EllipticCurve パラメーターも指定されていない場合は、ファームの既定のキーアルゴリズムとキーサイズ/楕円曲線が使用されます。

Type:	Int32
Accepted values:	0, 2048, 4096, 8192, 16384
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Locality

組織が法的に配置されている都市または地域の名前。名前を省略しないでください。このパラメーターを指定しない場合は、ファームの既定のロケールが使用されます。

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

-Organization

組織または会社の法的に登録された名前。このパラメーターを指定しない場合は、ファームの既定の組織が使用されます。

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

-OrganizationalUnit

組織内または会社内の部署の名前。このパラメーターを指定しない場合は、ファームの既定の組織単位が使用されます。

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

-Path

生成される証明書署名要求ファイルへのパス。

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

-State

組織が法的に配置されている州または都道府県の名前。名前を省略しないでください。このパラメーターを指定しない場合は、ファームの既定の状態が使用されます。

Type:	String
Position:	Named
Default value:	None
Required:	False
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

次の方法で共有