|
| 1 | +--- |
| 2 | +external help file: Microsoft.Open.Teams.CommonLibrary.dll-Help.xml |
| 3 | +Module Name: MicrosoftTeams |
| 4 | +applicable: Microsoft Teams |
| 5 | +title: Connect-MicrosoftTeams |
| 6 | +online version: |
| 7 | +schema: 2.0.0 |
| 8 | +--- |
| 9 | + |
| 10 | +# Connect-MicrosoftTeams |
| 11 | + |
| 12 | +## SYNOPSIS |
| 13 | +Note: This cmdlet is currently in Beta. |
| 14 | + |
| 15 | +## SYNTAX |
| 16 | + |
| 17 | +### UserCredential (Default) |
| 18 | +``` |
| 19 | +Connect-MicrosoftTeams [-TenantId <String>] [-Credential <PSCredential>] [-AccountId <String>] |
| 20 | + [-LogLevel <LogLevel>] [-LogFilePath <String>] [-WhatIf] [-Confirm] |
| 21 | +``` |
| 22 | + |
| 23 | +### ServicePrincipalCertificate |
| 24 | +``` |
| 25 | +Connect-MicrosoftTeams -TenantId <String> -CertificateThumbprint <String> -ApplicationId <String> |
| 26 | + [-LogLevel <LogLevel>] [-LogFilePath <String>] [-WhatIf] [-Confirm] |
| 27 | +``` |
| 28 | + |
| 29 | +### AccessToken |
| 30 | +``` |
| 31 | +Connect-MicrosoftTeams [-TenantId <String>] -AadAccessToken <String> [-MsAccessToken <String>] |
| 32 | + -AccountId <String> [-LogLevel <LogLevel>] [-LogFilePath <String>] [-WhatIf] [-Confirm] |
| 33 | +``` |
| 34 | + |
| 35 | +## DESCRIPTION |
| 36 | + |
| 37 | +## EXAMPLES |
| 38 | + |
| 39 | +## PARAMETERS |
| 40 | + |
| 41 | +### -TenantId |
| 42 | +@{Text=} |
| 43 | + |
| 44 | +```yaml |
| 45 | +Type: String |
| 46 | +Parameter Sets: UserCredential, AccessToken |
| 47 | +Aliases: Domain, TenantDomain |
| 48 | +Applicable: Microsoft Teams |
| 49 | + |
| 50 | +Required: False |
| 51 | +Position: Named |
| 52 | +Default value: None |
| 53 | +Accept pipeline input: False |
| 54 | +Accept wildcard characters: False |
| 55 | +``` |
| 56 | +
|
| 57 | +```yaml |
| 58 | +Type: String |
| 59 | +Parameter Sets: ServicePrincipalCertificate |
| 60 | +Aliases: Domain, TenantDomain |
| 61 | +Applicable: Microsoft Teams |
| 62 | + |
| 63 | +Required: True |
| 64 | +Position: Named |
| 65 | +Default value: None |
| 66 | +Accept pipeline input: False |
| 67 | +Accept wildcard characters: False |
| 68 | +``` |
| 69 | +
|
| 70 | +### -Credential |
| 71 | +@{Text=} |
| 72 | +
|
| 73 | +```yaml |
| 74 | +Type: PSCredential |
| 75 | +Parameter Sets: UserCredential |
| 76 | +Aliases: |
| 77 | +Applicable: Microsoft Teams |
| 78 | + |
| 79 | +Required: False |
| 80 | +Position: Named |
| 81 | +Default value: None |
| 82 | +Accept pipeline input: False |
| 83 | +Accept wildcard characters: False |
| 84 | +``` |
| 85 | +
|
| 86 | +### -AccountId |
| 87 | +@{Text=} |
| 88 | +
|
| 89 | +```yaml |
| 90 | +Type: String |
| 91 | +Parameter Sets: UserCredential |
| 92 | +Aliases: |
| 93 | +Applicable: Microsoft Teams |
| 94 | + |
| 95 | +Required: False |
| 96 | +Position: Named |
| 97 | +Default value: None |
| 98 | +Accept pipeline input: False |
| 99 | +Accept wildcard characters: False |
| 100 | +``` |
| 101 | +
|
| 102 | +```yaml |
| 103 | +Type: String |
| 104 | +Parameter Sets: AccessToken |
| 105 | +Aliases: |
| 106 | +Applicable: Microsoft Teams |
| 107 | + |
| 108 | +Required: True |
| 109 | +Position: Named |
| 110 | +Default value: None |
| 111 | +Accept pipeline input: False |
| 112 | +Accept wildcard characters: False |
| 113 | +``` |
| 114 | +
|
| 115 | +### -LogLevel |
| 116 | +@{Text=} |
| 117 | +
|
| 118 | +```yaml |
| 119 | +Type: LogLevel |
| 120 | +Parameter Sets: (All) |
| 121 | +Aliases: |
| 122 | +Applicable: Microsoft Teams |
| 123 | + |
| 124 | +Required: False |
| 125 | +Position: Named |
| 126 | +Default value: None |
| 127 | +Accept pipeline input: False |
| 128 | +Accept wildcard characters: False |
| 129 | +``` |
| 130 | +
|
| 131 | +### -LogFilePath |
| 132 | +@{Text=} |
| 133 | +
|
| 134 | +```yaml |
| 135 | +Type: String |
| 136 | +Parameter Sets: (All) |
| 137 | +Aliases: |
| 138 | +Applicable: Microsoft Teams |
| 139 | + |
| 140 | +Required: False |
| 141 | +Position: Named |
| 142 | +Default value: None |
| 143 | +Accept pipeline input: False |
| 144 | +Accept wildcard characters: False |
| 145 | +``` |
| 146 | +
|
| 147 | +### -WhatIf |
| 148 | +@{Text=} |
| 149 | +
|
| 150 | +```yaml |
| 151 | +Type: SwitchParameter |
| 152 | +Parameter Sets: (All) |
| 153 | +Aliases: wi |
| 154 | +Applicable: Microsoft Teams |
| 155 | + |
| 156 | +Required: False |
| 157 | +Position: Named |
| 158 | +Default value: None |
| 159 | +Accept pipeline input: False |
| 160 | +Accept wildcard characters: False |
| 161 | +``` |
| 162 | +
|
| 163 | +### -Confirm |
| 164 | +@{Text=} |
| 165 | +
|
| 166 | +```yaml |
| 167 | +Type: SwitchParameter |
| 168 | +Parameter Sets: (All) |
| 169 | +Aliases: cf |
| 170 | +Applicable: Microsoft Teams |
| 171 | + |
| 172 | +Required: False |
| 173 | +Position: Named |
| 174 | +Default value: None |
| 175 | +Accept pipeline input: False |
| 176 | +Accept wildcard characters: False |
| 177 | +``` |
| 178 | +
|
| 179 | +### -CertificateThumbprint |
| 180 | +@{Text=} |
| 181 | +
|
| 182 | +```yaml |
| 183 | +Type: String |
| 184 | +Parameter Sets: ServicePrincipalCertificate |
| 185 | +Aliases: |
| 186 | +Applicable: Microsoft Teams |
| 187 | + |
| 188 | +Required: True |
| 189 | +Position: Named |
| 190 | +Default value: None |
| 191 | +Accept pipeline input: False |
| 192 | +Accept wildcard characters: False |
| 193 | +``` |
| 194 | +
|
| 195 | +### -ApplicationId |
| 196 | +@{Text=} |
| 197 | +
|
| 198 | +```yaml |
| 199 | +Type: String |
| 200 | +Parameter Sets: ServicePrincipalCertificate |
| 201 | +Aliases: |
| 202 | +Applicable: Microsoft Teams |
| 203 | + |
| 204 | +Required: True |
| 205 | +Position: Named |
| 206 | +Default value: None |
| 207 | +Accept pipeline input: False |
| 208 | +Accept wildcard characters: False |
| 209 | +``` |
| 210 | +
|
| 211 | +### -AadAccessToken |
| 212 | +@{Text=} |
| 213 | +
|
| 214 | +```yaml |
| 215 | +Type: String |
| 216 | +Parameter Sets: AccessToken |
| 217 | +Aliases: |
| 218 | +Applicable: Microsoft Teams |
| 219 | + |
| 220 | +Required: True |
| 221 | +Position: Named |
| 222 | +Default value: None |
| 223 | +Accept pipeline input: False |
| 224 | +Accept wildcard characters: False |
| 225 | +``` |
| 226 | +
|
| 227 | +### -MsAccessToken |
| 228 | +@{Text=} |
| 229 | +
|
| 230 | +```yaml |
| 231 | +Type: String |
| 232 | +Parameter Sets: AccessToken |
| 233 | +Aliases: |
| 234 | +Applicable: Microsoft Teams |
| 235 | + |
| 236 | +Required: False |
| 237 | +Position: Named |
| 238 | +Default value: None |
| 239 | +Accept pipeline input: False |
| 240 | +Accept wildcard characters: False |
| 241 | +``` |
| 242 | +
|
| 243 | +## INPUTS |
| 244 | +
|
| 245 | +## OUTPUTS |
| 246 | +
|
| 247 | +## NOTES |
| 248 | +
|
| 249 | +## RELATED LINKS |
| 250 | +
|
0 commit comments