New-SPTrustedServiceTokenIssuer
Creates a trust with a SharePoint farm.
Syntax
New-SPTrustedServiceTokenIssuer
[-Name] <String>
-Certificate <X509Certificate2>
[-AssignmentCollection <SPAssignmentCollection>]
[-Description <String>]
[-Confirm]
[-WhatIf]
[<CommonParameters>]
New-SPTrustedServiceTokenIssuer
[-Name] <String>
[-AssignmentCollection <SPAssignmentCollection>]
[-Description <String>]
[-Confirm]
-MetadataEndPoint <Uri>
[-WhatIf]
[<CommonParameters>]
Description
The New-SPTrustedServiceTokenIssuer
cmdlet creates a trust with a SharePoint farm.
If a certificate file is used, it must have only one X509 certificate without private keys, otherwise an exception is raised.
For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.
Examples
------------------EXAMPLE 1------------------
$cert = Get-PfxCertificate C:\LiveIDSigningCert.pfx
New-SPTrustedServiceTokenIssuer -Name "WFEFarm1" -Description "WFE Farm 1" -Certificate $cert
This example shows how to create a new SharePoint Farm trust using the trust certificate from a file.
Parameters
-AssignmentCollection
Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
When the Global parameter is used, all objects are contained in the global store.
If objects are not immediately used, or disposed of by using the Stop-SPAssignment
command, an out-of-memory scenario can occur.
Type: | SPAssignmentCollection |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | SharePoint Server Subscription Edition |
-Certificate
The type must be a name of a valid X.509 certificate; for example, Certificate1.
Specifies the X.509 certificate object from trusted authentication provider farm.
Type: | X509Certificate2 |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | SharePoint Server Subscription Edition |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | SharePoint Server Subscription Edition |
-Description
Specifies a description for the trust.
The type must be a valid string; for example, WFE Farm Trust1.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | SharePoint Server Subscription Edition |
-MetadataEndPoint
Specifies the URI for the metadata endpoint of the trusted provider.
Type: | Uri |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | SharePoint Server Subscription Edition |
-Name
Specifies the name of the trust.
The type must be a valid name of a trusted service issuer; for example, WFEFarmTrust1.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | SharePoint Server Subscription Edition |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | SharePoint Server Subscription Edition |