Get-CsOnlineDialInConferencingUser
Use the Get-CsOnlineDialInConferencingUser
cmdlet to view the properties and settings of users that are enabled for dial-in conferencing and are using Microsoft as their PSTN conferencing provider.
Syntax
Get-CsOnlineDialInConferencingUser
[-BridgeName <String>]
[-ServiceNumber <String>]
[-TenantDomain <String>]
[-LdapFilter <String>]
[[-Identity] <UserIdParameter>]
[-Tenant <Guid>]
[-BridgeId <Guid>]
[-ResultSize <Int32>]
[-DomainController <Fqdn>]
[-Force]
[<CommonParameters>]
Description
This cmdlet will only return users that have been enabled for audio conferencing using Microsoft as the audio conferencing provider. Users that are enabled for audio conferencing using a third-party audio conferencing provider won't be returned. If there are no users in the organization that have been enabled for audio conferencing, then the cmdlet will return no results.
The see a list of users with conferencing providers other than Microsoft use the Get-CsUserAcp cmdlet.
NOTE: In the Teams PowerShell Module version 3.0 or later, the following input parameters have been deprecated for TeamsOnly customers (removed or very low usage):
- BridgeId
- BridgeName
- DomainController
- Force
- LdapFilter
- ServiceNumber
- TenantDomain
- Common Parameters
Examples
-------------------------- Example 1 --------------------------
PS C:\> Get-CsOnlineDialInConferencingUser -Identity Ken.Myer@contoso.com
This example uses the User Principal Name (UPN) to retrieve the BridgeID and ServiceNumber information.
Parameters
-BridgeId
This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage.
Specifies the globally-unique identifier (GUID) for the audio conferencing bridge.
Type: | Guid |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Microsoft Teams |
-BridgeName
This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage.
Specifies the name for the audio conferencing bridge.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Microsoft Teams |
-DomainController
This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage.
This parameter is reserved for internal Microsoft use.
Type: | Fqdn |
Aliases: | DC |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Microsoft Teams |
-Force
This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage.
The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Microsoft Teams |
-Identity
Specifies the user to retrieve. The user can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the user's Active Directory distinguished name.
Type: | UserIdParameter |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Microsoft Teams |
-LdapFilter
This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage.
Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server 2015). For example, you can limit returned data to users who work in a specific department, or users who have a specified manager or job title. The LdapFilter parameter uses the LDAP query language when creating filters. For example, a filter that returns only users who work in the city of Redmond would look like this: "l=Redmond", with "l" (a lowercase L) representing the Active Directory attribute (locality); "=" representing the comparison operator (equal to); and "Redmond" representing the filter value.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Microsoft Teams |
-ResultSize
Enables you to limit the number of records returned by the cmdlet. For example, to return seven users (regardless of the number of users that are in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven users will be returned. The result size can be set to any whole number between 0 and 2147483647, inclusive. If set to 0 the command will run, but no data will be returned. If you set the ResultSize to 7 but you have only three users in your forest, the command will return those three users, and then complete without error.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Microsoft Teams |
-ServiceNumber
This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage.
Specifies a service number to serve as a filter for the returned user collection. Only users who have been assigned the specified number will be returned. The service number can be specified in the following formats: E.164 number, +<E.164 number> and \<E.164 number>.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Microsoft Teams |
-Tenant
This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage.
NOTE: This parameter is reserved for internal Microsoft use.
Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". You can find your tenant ID by running this command:
Get-CsTenant | Select-Object DisplayName, TenantID
Type: | Guid |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Microsoft Teams |
-TenantDomain
This parameter has been deprecated from Teams PowerShell Modules 3.0 and above due to limited usage.
This parameter is reserved for internal Microsoft use.
Type: | Object |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Microsoft Teams |