en-US/Connect-OnlineService-help.xml

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
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Connect-OnlineService</command:name>
      <command:verb>Connect</command:verb>
      <command:noun>OnlineService</command:noun>
      <maml:description>
        <maml:para>Facade to individual connection handlers</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Handles calling the proper connection handler for a given service.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Connect-OnlineService</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
          <maml:name>Service</maml:name>
          <maml:Description>
            <maml:para>Defines the service that you wish to connect to. Accepts: `MicrosoftOnline`, `AzureADv2`, `ExchangeOnline`, `SecurityAndComplianceCenter`.</maml:para>
            <maml:para>If you specify `SecurityAndComplianceCenter`, then `-Delegated` and `-ClientDomain` are not supported as Microsoft does not currently support delegated access to the Security and Compliance Center.</maml:para>
          </maml:Description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>String</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">
          <maml:name>Delegated</maml:name>
          <maml:Description>
            <maml:para>Instructs the function that you wish to connect with delegated permissions to a tenent</maml:para>
          </maml:Description>
          <dev:type>
            <maml:name>SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none">
          <maml:name>ClientDomain</maml:name>
          <maml:Description>
            <maml:para>The tenant domain name (contoso.onmicrosoft.com) or domain name registered with the tenant you wish to connect to (contoso.com)</maml:para>
          </maml:Description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>String</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
        <maml:name>Service</maml:name>
        <maml:Description>
          <maml:para>Defines the service that you wish to connect to. Accepts: `MicrosoftOnline`, `AzureADv2`, `ExchangeOnline`, `SecurityAndComplianceCenter`.</maml:para>
          <maml:para>If you specify `SecurityAndComplianceCenter`, then `-Delegated` and `-ClientDomain` are not supported as Microsoft does not currently support delegated access to the Security and Compliance Center.</maml:para>
        </maml:Description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">
        <maml:name>Delegated</maml:name>
        <maml:Description>
          <maml:para>Instructs the function that you wish to connect with delegated permissions to a tenent</maml:para>
        </maml:Description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none">
        <maml:name>ClientDomain</maml:name>
        <maml:Description>
          <maml:para>The tenant domain name (contoso.onmicrosoft.com) or domain name registered with the tenant you wish to connect to (contoso.com)</maml:para>
        </maml:Description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes />
    <command:returnValues />
    <maml:alertSet>
      <maml:alert>
        <maml:para></maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>---------- Connect to Exchange Online (Supports MFA) ----------</maml:title>
        <dev:code>PS C:\&gt; Connect-OnlineService ExchangeOnline</dev:code>
        <dev:remarks>
          <maml:para></maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>Delegated connection to Exchange Online (Does not support MFA)</maml:title>
        <dev:code>PS C:\&gt; Connect-OnlineService -Service ExchangeOnline -Delegated -ClientDomain fabrikam.com</dev:code>
        <dev:remarks>
          <maml:para></maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version:</maml:linkText>
        <maml:uri>https://rearmedhalo.github.io/DUST/Connect-OnlineService.html</maml:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
</helpItems>