|
| 1 | +--- |
| 2 | +external help file: MicrosoftTeams-help.xml |
| 3 | +Module Name: MicrosoftTeams |
| 4 | +applicable: Microsoft Teams |
| 5 | +online version: |
| 6 | +title: New-CsSdgBulkSignInRequest |
| 7 | +schema: 2.0.0 |
| 8 | +--- |
| 9 | + |
| 10 | +# New-CsSdgBulkSignInRequest |
| 11 | + |
| 12 | +## SYNOPSIS |
| 13 | +Use the New-CsSdgBulkSignInRequest cmdlet to sign in a batch of up to 100 devices. |
| 14 | + |
| 15 | +## SYNTAX |
| 16 | + |
| 17 | +``` |
| 18 | +New-CsSdgBulkSignInRequest -DeviceDetailsFilePath <String> -Region <String> [<CommonParameters>] |
| 19 | +``` |
| 20 | + |
| 21 | +## DESCRIPTION |
| 22 | +Bulk Sign In for Teams SIP Gateway enables you to sign in a batch of devices in one go. This feature is intended for admins and works for shared devices. |
| 23 | +The password for the shared device account is reset at runtime to an unknown value and the cmdlet uses the new credential for fetching token from Entra ID. Admins can sign in shared account remotely and in bulk using this feature. |
| 24 | + |
| 25 | +## EXAMPLES |
| 26 | + |
| 27 | +### Example 1 |
| 28 | +```powershell |
| 29 | +Import-Module MicrosoftTeams |
| 30 | +$credential = Get-Credential // Enter your admin’s email and password |
| 31 | +Connect-MicrosoftTeams –Credential $credential |
| 32 | +$newBatchResponse = New-CsSdgBulkSignInRequest -DeviceDetailsFilePath .\Example.csv -Region APAC |
| 33 | +``` |
| 34 | + |
| 35 | +This example shows how to connect to Microsoft Teams PowerShell module, and read the output of the New-SdgBulkSignInRequest cmdlet into a variable newBatchResponse. The cmdlet uses Example.csv as the device details file, and SIP Gateway region as APAC. |
| 36 | + |
| 37 | +### Example 2 |
| 38 | +```powershell |
| 39 | +$newBatchResponse = New-CsSdgBulkSignInRequest -DeviceDetailsFilePath .\Example.csv -Region APAC |
| 40 | +$newBatchResponse.BatchId |
| 41 | +$getBatchStatusResponse = Get-CsSdgBulkSignInRequestStatus -Batchid $newBatchResponse.BatchId |
| 42 | +$getBatchStatusResponse | ft |
| 43 | +$getBatchStatusResponse.BatchItem |
| 44 | +``` |
| 45 | +This example shows how to view the status of a bulk sign in batch. |
| 46 | + |
| 47 | + |
| 48 | +## PARAMETERS |
| 49 | + |
| 50 | +### -DeviceDetailsFilePath |
| 51 | +This is the path of the device details CSV file. The CSV file contains two columns - username and hardware ID, where username is of the format [email protected] and hardware ID is the device MAC address in the format 1A-2B-3C-4D-5E-6F |
| 52 | + |
| 53 | +```yaml |
| 54 | +Type: String |
| 55 | +Parameter Sets: (All) |
| 56 | +Aliases: |
| 57 | + |
| 58 | +Required: True |
| 59 | +Position: Named |
| 60 | +Default value: None |
| 61 | +Accept pipeline input: False |
| 62 | +Accept wildcard characters: False |
| 63 | +``` |
| 64 | +
|
| 65 | +### -Region |
| 66 | +This is the SIP Gateway region. Possible values include NOAM, EMEA, APAC. |
| 67 | +
|
| 68 | +```yaml |
| 69 | +Type: String |
| 70 | +Parameter Sets: (All) |
| 71 | +Aliases: |
| 72 | + |
| 73 | +Required: True |
| 74 | +Position: Named |
| 75 | +Default value: None |
| 76 | +Accept pipeline input: False |
| 77 | +Accept wildcard characters: False |
| 78 | +``` |
| 79 | +
|
| 80 | +### CommonParameters |
| 81 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). |
| 82 | +
|
| 83 | +## INPUTS |
| 84 | +
|
| 85 | +### None |
| 86 | +
|
| 87 | +## OUTPUTS |
| 88 | +
|
| 89 | +### System.Object |
| 90 | +## NOTES |
| 91 | +
|
| 92 | +## RELATED LINKS |
0 commit comments