en-US/Microsoft.Exchange.Management.ExoPowershellGalleryModule.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ConnectionInformation</command:name> <command:verb>Get</command:verb> <command:noun>ConnectionInformation</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell module v2.0.6-Preview7 or later. For more information, see About the Exchange Online PowerShell module (https://aka.ms/exov3-module).</maml:para> <maml:para>Use the Get-ConnectionInformation cmdlet to get information about all REST-based connections in the current PowerShell instance with Exchange Online.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-ConnectionInformation cmdlet returns the information about all active REST-based connections with Exchange Online in the current PowerShell instance. This cmdlet is equivalent to the Get-PSSession cmdlet that's used with remote PowerShell sessions.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ConnectionInformation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectionId</maml:name> <maml:description> <maml:para>Note : This parameter is available in version 3.2.0-Preview2 or later of the module.</maml:para> <maml:para>Specifies an array of connection IDs. This cmdlet returns the connections that have the specified connection IDs.</maml:para> <maml:para>The ConnectionID is a GUID that uniquely identifies a connection in the current connections. The ConnectionID is unique, even when you have multiple connections running on a single computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ConnectionInformation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModulePrefix</maml:name> <maml:description> <maml:para>Note : This parameter is available in version 3.2.0-Preview2 or later of the module.</maml:para> <maml:para>Specifies an array of module prefixes. This cmdlet returns the connections that have the specified module prefixes.</maml:para> <maml:para>Prefix specifies a text value to add to the beginning of a cmdlet names when you connect. When creating a new connection, in prefix -</maml:para> <maml:para>- You can't use spaces or special characters like underscores or asterisks.</maml:para> <maml:para>- You can't use the value EXO. This value is reserved for the nine exclusive Get-EXO\ * cmdlets in the module.</maml:para> <maml:para></maml:para> <maml:para>This cmdlet will only return connections if the connection was created with Prefix parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectionId</maml:name> <maml:description> <maml:para>Note : This parameter is available in version 3.2.0-Preview2 or later of the module.</maml:para> <maml:para>Specifies an array of connection IDs. This cmdlet returns the connections that have the specified connection IDs.</maml:para> <maml:para>The ConnectionID is a GUID that uniquely identifies a connection in the current connections. The ConnectionID is unique, even when you have multiple connections running on a single computer.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModulePrefix</maml:name> <maml:description> <maml:para>Note : This parameter is available in version 3.2.0-Preview2 or later of the module.</maml:para> <maml:para>Specifies an array of module prefixes. This cmdlet returns the connections that have the specified module prefixes.</maml:para> <maml:para>Prefix specifies a text value to add to the beginning of cmdlet names when you connect. When creating a new connection, in prefix -</maml:para> <maml:para>- You can't use spaces or special characters like underscores or asterisks.</maml:para> <maml:para>- You can't use the value EXO. This value is reserved for the nine exclusive Get-EXO\ * cmdlets in the module.</maml:para> <maml:para></maml:para> <maml:para>This cmdlet will only return connections if the connection was created with Prefix parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-ConnectionInformation</dev:code> <dev:remarks> <maml:para>This example returns a list of all active REST-based connections with Exchange Online in the current PowerShell instance.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-ConnectionInformation -ConnectionId <%Connection_id%></dev:code> <dev:remarks> <maml:para>This example returns a list of active REST-based connections with Exchange Online with given Connection IDs in the current PowerShell instance.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-ConnectionInformation -ModulePrefix Prefix1,Prefix2</dev:code> <dev:remarks> <maml:para>This example returns a list of active REST-based connections with Exchange Online with prefixes: Prefix1 and Prefix2 in the current PowerShell instance.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://learn.microsoft.com/powershell/module/exchange/get-connectioninformation</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |