Renew-SPCertificate

參考

模組:: sharepoint-server

適用於:: SharePoint Server Subscription Edition

更新憑證並建立新的憑證簽署要求。

Syntax

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>]

Description

SharePoint 支援透過 Renew-SPCertificate PowerShell Cmdlet 更新 SSL 憑證。這會根據現有憑證的屬性建立新的憑證簽署要求，並且是更新 SSL 憑證的三步驟程式中的第一個步驟。

透過作業建立 SSL 憑證要求之後，SharePoint 系統管理員必須將憑證要求提交給其 SSL 憑證頒發機構單位。 SSL 憑證頒發機構單位接著會根據要求產生已簽署的憑證，並將其傳回給 SharePoint 系統管理員。然後，SharePoint 系統管理員必須將 SSL 憑證頒發機構單位提供的憑證匯入 SharePoint。接著，SharePoint 會將匯入的憑證與憑證要求作業所產生的私密金鑰配對。憑證便已準備好供 SharePoint 使用。

當您在憑證更新作業中匯入憑證時，可以使用 Import-SPCertificate Cmdlet 來指定 Replace switch 參數。這會指示 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 物件將物件指派給變數，並在不需要時處置這些物件，以釋放記憶體。使用 SPWeb、SPSite 或 SPSiteAdministration 物件時，若未使用指派集合或 Global 參數，將會自動處置這些物件。

使用 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

執行 Cmdlet 之前提示您確認。

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 金鑰的橢圓曲線。

較大的橢圓曲線提供比較小的橢圓曲線更多的密碼編譯強度，但其運算成本也更高，而且需要更多時間來完成 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 金鑰大小。

相較于較小的金鑰大小，較大的金鑰大小可提供更多的密碼編譯強度，但其運算成本也更高，而且需要更多時間來完成 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

顯示執行 Cmdlet 時會發生什麼情況。未執行 Cmdlet。

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