Set-SPProfileServiceApplicationProxy
Published: July 16, 2012
Applies to: SharePoint Server 2013 Enterprise
Sets properties of a proxy for a User Profile Service application.
Set-SPProfileServiceApplicationProxy [-Identity] <SPServiceApplicationProxyPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-DefaultProxyGroup <SwitchParameter>] [-MySiteHostLocation <SPSitePipeBind>] [-MySiteManagedPath <SPPrefixPipeBind>] [-Name <String>] [-SiteNamingConflictResolution <String>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.SharePoint.PowerShell.SPServiceApplicationProxyPipeBind | Specifies the User Profile Service application proxy to update. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a service application proxy (for example, UserProfileSvcProxy1); or an instance of a valid SPServiceApplicationProxy object. | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | 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.
| ||
| Confirm | Optional | System.Management.Automation.SwitchParameter | Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters | ||
| DefaultProxyGroup | Optional | System.Management.Automation.SwitchParameter | Specifies that the User Profile Service application proxy is added to the default proxy group for the local farm. | ||
| MySiteHostLocation | Optional | Microsoft.SharePoint.PowerShell.SPSitePipeBind | Specifies the site collection where the My Site will be created. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or a valid URL, in the form http://server_name; or an instance of a valid SPSite object. | ||
| MySiteManagedPath | Optional | Microsoft.SharePoint.PowerShell.SPPrefixPipeBind | Specifies the managed path location of personal sites. The type must be a valid URL, in the form http://server_name. | ||
| Name | Optional | System.String | Specifies the display name for the User Profile Service application. The name that you use must be a unique name of a User Profile Service application in this farm. The name can be a maximum of 128 characters. The type must be a name of a valid service application proxy; for example, UserProfileSvcProxy1. | ||
| SiteNamingConflictResolution | Optional | System.String | Specifies the format to use to name personal sites. Use one of the following integer values: 1 Personal site collections are to be based on user names without any conflict resolution. For example, http://portal_site/location/username/ 2 Personal site collections are to be based on user names with conflict resolution by using domain names. For example, .../username/ or .../domain_username/ 3 Personal site collections are to be named by using domain and user name always, to avoid any conflicts. For example, http://portal_site/location/domain_username/ The default value is 1 (do not resolve conflicts). | ||
| WhatIf | Optional | System.Management.Automation.SwitchParameter | Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters |
Detailed Description
The Set-SPProfileServiceApplicationProxy cmdlet sets properties of a proxy for a User Profile Service application.
Input Types
Return Types
----------------EXAMPLE---------------------
#Get UPA Proxy$pr = Get-SPServiceApplicationProxy | ? {$_.DisplayName.Contains(PartitionedUserProfileApplication_Proxy)}
#Change the name of the proxySet-SPProfileServiceApplicationProxy –Identity $pr –Name PartitionedUserProfileApplication_Proxy2
This example sets a proxy for the User Profile Service application.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |

Note: