Set-NectarEndpoint
- 21 Aug 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Set-NectarEndpoint
- Updated on 21 Aug 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Modify properties of a Nectar DXP endpoint
Syntax
Set-NectarEndpoint
-SearchQuery <String>
-UserName <String>
-DisplayName <String>
-IsHub <Boolean>
-TenantName <String>
-PageSize <Int32>
-ResultSize <Int32>
Examples
Example 1
Set-NectarEndpoint -SearchQuery ff4bf84a-04d8-11ec-ad2e-17d4f8d1df89 -UserName tferguson@contoso.com -IsHub $False
Sets a specific endpoint's associated username to 'tferguson'
Parameters
-SearchQuery <String>
A string to search for to return a specific endpoint. Will search for match against all fields
| Parameter | Value |
|---|---|
| Required | true |
| Position | 1 |
| Required | true |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-UserName <String>
The username to associate with the given endpoint. Set to $NULL to de-associate a user with an endpoint
| Parameter | Value |
|---|---|
| Required | false |
| Position | 2 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-DisplayName <String>
| Parameter | Value |
|---|---|
| Required | false |
| Position | 3 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-IsHub <Boolean>
Set the endpoint to be a hub endpoint or not.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 4 |
| Required | false |
| Default Value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-TenantName <String>
The name of the Nectar DXP tenant. Used in multi-tenant configurations.
| Parameter | Value |
|---|---|
| Required | false |
| Position | 5 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-PageSize <Int32>
| Parameter | Value |
|---|---|
| Required | false |
| Position | 6 |
| Required | false |
| Default Value | 1000 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-ResultSize <Int32>
| Parameter | Value |
|---|---|
| Required | false |
| Position | 7 |
| Required | false |
| Default Value | 100000 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Was this article helpful?