universal-docs/cmdlets/Get-PSUEndpoint.txt at v5 · ironmansoftware/universal-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

NAME
    Get-PSUEndpoint

SYNOPSIS
    Returns all endpoints defined in PowerShell Universal.


SYNTAX
    Get-PSUEndpoint [-AppToken <String>] [-ComputerName <String>] [-Id <Int64>] [-UseDefaultCredentials] [-Integrated] [-Credential <PSCredential>] [-TrustCertificate] [<CommonParameters>]

    Get-PSUEndpoint [-AppToken <String>] [-ComputerName <String>] [-Url <String>] [-UseDefaultCredentials] [-Integrated] [-Credential <PSCredential>] [-TrustCertificate] [<CommonParameters>]


DESCRIPTION
    Returns all endpoints defined in PowerShell Universal.


PARAMETERS
    -AppToken <String>
        The AppToken that is used for calling the PowerShell Universal Management API. You can also call Connect-PSUServer before calling this cmdlet to set the AppToken for the entire session.

        Required?                    false
        Position?                    named
        Default value                None
        Accept pipeline input?       False
        Aliases                      none
        Accept wildcard characters?  false

    -ComputerName <String>
        Specifies the computer name or URL that should be called when accessing the PowerShell Universal Management API. You can also use Connect-PSUServer before calling this cmdlet to set the computer name for the entire session.

        Required?                    false
        Position?                    named
        Default value                None
        Accept pipeline input?       False
        Aliases                      Uri
        Accept wildcard characters?  false

    -Id <Int64>
        The ID of the endpoint to return.

        Required?                    false
        Position?                    named
        Default value                None
        Accept pipeline input?       False
        Aliases                      none
        Accept wildcard characters?  false

    -Url <String>
        The URL of the endpoints to return. Multiple endpoints may have the same URL and different verbs.

        Required?                    false
        Position?                    named
        Default value                None
        Accept pipeline input?       False
        Aliases                      none
        Accept wildcard characters?  false

    -UseDefaultCredentials [<SwitchParameter>]
        Use default credentials when connecting to the management API

        Required?                    false
        Position?                    named
        Default value                False
        Accept pipeline input?       False
        Aliases                      none
        Accept wildcard characters?  false

    -Integrated [<SwitchParameter>]
        Executes the command internally rather than using the Management API. Only works when running script from within PowerShell Universal.

        Required?                    false
        Position?                    named
        Default value                False
        Accept pipeline input?       False
        Aliases                      none
        Accept wildcard characters?  false

    -Credential <PSCredential>
        Credentials to login to the PowerShell Universal Management API.

        Required?                    false
        Position?                    named
        Default value                None
        Accept pipeline input?       False
        Aliases                      none
        Accept wildcard characters?  false

    -TrustCertificate [<SwitchParameter>]
        Whether the cmdlet should ignore certificate issues.

        Required?                    false
        Position?                    named
        Default value                False
        Accept pipeline input?       False
        Aliases                      none
        Accept wildcard characters?  false

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS
    None


OUTPUTS
    System.Object


NOTES


    -------------------------- Example 1 --------------------------

    PS C:\> Get-PSUEndpoint

    Returns all endpoints.
    -------------------------- Example 2 --------------------------

    PS C:\> Get-PSUEndpoint -Id 1

    Returns the endpoint that has Id 1. Ids are reset when the server is restarted.
    -------------------------- Example 3 --------------------------

    PS C:\> Get-PSUEndpoint -Url '/url'

    Returns the endpoints that have the URL '/url'.

RELATED LINKS