Изменить

Get-CsOnlineApplicationInstance

  • Reference
Module:
MicrosoftTeamsPowerShell
Applies to:
Microsoft Teams

Get application instance for the tenant from Microsoft Entra ID.

Syntax

Get-CsOnlineApplicationInstance
   [[-Identity] <string>]
   [[-Identities] <string>]
   [[-ResultSize] <int>]
   [[-Skip] <int>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

This cmdlet is used to get details of an application instance.

Examples

-------------------------- Example 1 --------------------------

Get-CsOnlineApplicationInstance -Identity appinstance01@contoso.com

This example returns the application instance with identity "appinstance01@contoso.com".

-------------------------- Example 2 --------------------------

Get-CsOnlineApplicationInstance -Identities appinstance01@contoso.com,appinstance02@contoso.com

This example returns the application instance with identities "appinstance01@contoso.com" and "appinstance02@contoso.com". Query with multiple comma separated Identity.

-------------------------- Example 3 --------------------------

Get-CsOnlineApplicationInstance -ResultSize 10

This example returns the first 10 application instances.

-------------------------- Example 4 --------------------------

Get-CsOnlineApplicationInstance

This example returns the details of all application instances.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-Force

This switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If it isn't provided in the command, you're prompted for administrative input if required.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-Identities

The UPNs or the object IDs of the application instances to retrieve, separated with comma. If this parameter nor parameter Identity are not provided, it will retrieve all application instances in the tenant.

Type:System.String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-Identity

The UPN or the object ID of the application instance to retrieve. If this parameter nor parameter Identities are not provided, it will retrieve all application instances in the tenant.

Type:System.String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-ResultSize

The result size for bulk get. This parameter is currently not working.

Type:System.Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-Skip

Skips the first specified number of returned results. The default value is 0. This parameter is currently not working.

Type:System.Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Microsoft Teams