Set-MgmtSvcRelyingPartySettings

  • Reference
Module:
MgmtSvcConfig

Configures the management portal for administrators and management portal for tenants to use AD FS.

Syntax

Set-MgmtSvcRelyingPartySettings
   [-Target] <String[]>
   [-MetadataEndpoint <Uri>]
   [-MetadataFile <String>]
   [-DisableCertificateValidation]
   [-PortalConnectionString <String>]
   [-ManagementConnectionString <String>]
   [-Server <String>]
   [-UserName <String>]
   [-Password <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-MgmtSvcRelyingPartySettings
   [-Target] <String[]>
   [-MetadataEndpoint <Uri>]
   [-MetadataFile <String>]
   [-DisableCertificateValidation]
   [-PortalConnectionString <String>]
   [-ManagementConnectionString <String>]
   [-ConnectionString <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-MgmtSvcRelyingPartySettings cmdlet configures the management portal for administrators and management portal for tenants to use Active Directory Federation Services (AD FS). Specify one or more namespaces and an endpoint for metadata.

You can run this cmdlet from any computer in the deployment. However, this cmdlet assumes that the database is on the local computer. If the database is on another computer, you must use the Server, UserName, Password, and Database parameters, or a SQL connection string. If you specify a connection string by using the ConnectionString parameter, that value takes precedence over the Server, UserName, Password, and Database parameters.

Examples

Example 1: Configure a tenant portal

PS C:\> $ConnectionString = 'Data Source=rd-sdfre4;Initial Catalog=Microsoft.MgmtSvc.Config;User ID=SysAdmin;Password=Zoom2345'
PS C:\> Set-MgmtSvcRelyingPartySettings -Target Tenant -MetadataEndpoint "https://Server07.Contoso.com/FederationMetadata/2007-06/FederationMetadata.xml" -ConnectionString $ConnectionString  -DisableCertificateValidation

The first command stores a connection string in the $ConnectionString variable.

The second command specifies the target as a Tenant and specifies an endpoint. The command uses the connection string stored in the $ConnectionString variable and disables certificate validation.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-ConnectionString

Specifies an SQL connection string.

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

-DisableCertificateValidation

Indicates that the cmdlet disables certificate validation.

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

-ManagementConnectionString

Specifies a connection string for the Admin Site.

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

-MetadataEndpoint

Specifies an endpoint for identity provider metadata.

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

-MetadataFile

{{Fill MetadataFile Description}}

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

-Password

Specifies a password.

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

-PortalConnectionString

Specifies a connection string for the Tenant Site.

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

-Server

Specifies the name of the computer on which the SQL database resides.

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

-Target

Specifies the target site. Valid values are:

  • Admin. This value indicates that the target is the Admin Site, Admin API, and Tenant API.
  • Tenant. This value indicates that the target is the Tenant site and Tenant API.
Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-UserName

Specifies the name of a user account.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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