Set-MgmtSvcRelyingPartySettings

Set-MgmtSvcRelyingPartySettings

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

Syntax

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

Parameter Set: ConnectionString
Set-MgmtSvcRelyingPartySettings [-Target] <String[]> [-MetadataEndpoint] <Uri> [-ConnectionString <String> ] [-DisableCertificateValidation] [-ManagementConnectionString <String> ] [-PortalConnectionString <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]


 

Detailed 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.

Parameters

-ConnectionString<String>

Specifies an SQL connection string.

 

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

 

-DisableCertificateValidation

Indicates that the cmdlet disables certificate validation.

 

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

 

-ManagementConnectionString<String>

Specifies a connection string for the Admin Site.

 

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

 

-MetadataEndpoint<Uri>

Specifies an endpoint for identity provider metadata.

 

Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

 

-Password<String>

Specifies a password.

 

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

 

-PortalConnectionString<String>

Specifies a connection string for the Tenant Site.

 

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

 

-Server<String>

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

 

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

 

-Target<String[]>

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.

 

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

 

-UserName<String>

Specifies the name of a user account.

 

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

 

-Confirm

Prompts you for confirmation before executing the command.

 

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

 

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

 

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

 

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Examples

Example 1: Configure a tenant portal

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.

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