Skip to content

Latest commit

 

History

History
220 lines (170 loc) · 5.31 KB

Get-TeamsResourceAccount.md

File metadata and controls

220 lines (170 loc) · 5.31 KB
external help file Module Name online version schema
TeamsFunctions-help.xml
TeamsFunctions
2.0.0

Get-TeamsResourceAccount

SYNOPSIS

Returns Resource Accounts from AzureAD

SYNTAX

Identity (Default)

Get-TeamsResourceAccount [[-UserPrincipalName] <String[]>] [-IncludeTotalCount] [-Skip <UInt64>]
 [-First <UInt64>] [<CommonParameters>]

DisplayName

Get-TeamsResourceAccount [-DisplayName <String>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>]
 [<CommonParameters>]

AppType

Get-TeamsResourceAccount [-ApplicationType <String>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>]
 [<CommonParameters>]

Number

Get-TeamsResourceAccount [-PhoneNumber <String>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>]
 [<CommonParameters>]

DESCRIPTION

Returns one or more Resource Accounts based on input. This runs Get-CsOnlineApplicationInstance but reformats the Output with friendly names

EXAMPLES

EXAMPLE 1

Get-TeamsResourceAccount

Returns all Resource Accounts. Depending on size of the Tenant, this might take a while.

EXAMPLE 2

Get-TeamsResourceAccount -Identity ResourceAccount@TenantName.onmicrosoft.com

Returns the Resource Account with the Identity specified, if found.

EXAMPLE 3

Get-TeamsResourceAccount -DisplayName "Queue"

Returns all Resource Accounts with "Queue" as part of their Display Name. Use Find-TeamsResourceAccount / Find-CsOnlineApplicationInstance for finer search

EXAMPLE 4

Get-TeamsResourceAccount -ApplicationType AutoAttendant

Returns all Resource Accounts of the specified ApplicationType.

EXAMPLE 5

Get-TeamsResourceAccount -PhoneNumber +1555123456

Returns the Resource Account with the Phone Number specified, if found.

PARAMETERS

-UserPrincipalName

Default and positional. One or more UserPrincipalNames to be queried.

Type: String[]
Parameter Sets: Identity
Aliases: ObjectId, Identity

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-DisplayName

Optional. Search parameter. Alternative to Find-TeamsResourceAccount Use Find-TeamsUserVoiceConfig for more search options

Type: String
Parameter Sets: DisplayName
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ApplicationType

Optional. Returns all Call Queues or AutoAttendants

Type: String
Parameter Sets: AppType
Aliases: Type

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PhoneNumber

Optional. Returns all ResourceAccount with a specific string in the PhoneNumber

Type: String
Parameter Sets: Number
Aliases: Tel, Number, TelephoneNumber

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-IncludeTotalCount

Reports the total number of objects in the data set (an integer) followed by the selected objects. If the cmdlet cannot determine the total count, it displays "Unknown total count." The integer has an Accuracy property that indicates the reliability of the total count value. The value of Accuracy ranges from 0.0 to 1.0 where 0.0 means that the cmdlet could not count the objects, 1.0 means that the count is exact, and a value between 0.0 and 1.0 indicates an increasingly reliable estimate.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Skip

Ignores the specified number of objects and then gets the remaining objects. Enter the number of objects to skip.

Type: UInt64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-First

Gets only the specified number of objects. Enter the number of objects to get.

Type: UInt64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

System.String

OUTPUTS

System.Object

NOTES

Pipeline input possible Running the CmdLet without any input might take a while, depending on size of the Tenant.

RELATED LINKS

https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/Get-TeamsResourceAccount.md

https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/about_TeamsResourceAccount.md

https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/