EN-US/MSTeamsDirectRouting-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>Connect-Tdr</command:name> <command:verb>Connect</command:verb> <command:noun>Tdr</command:noun> <maml:description> <maml:para>Connects to Azure AD and Teams services using the AzureAD and Microsoft Teams Modules</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Connects and conducts various tests to make sure the necessary Powershell version and dependant modules are installed as well as the correct role is assigned to the logged in user</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-Tdr</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This CmdLet can be used to establish a session to: AzureAD and MicrosoftTeams Each Service has different requirements for connection, query (Get-CmdLets), and action (other CmdLets) For AzureAD, no particular role is needed for connection and query. Get-CmdLets are available without an Admin-role. For MicrosoftTeams, Teams Administrator Role is required</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Connect-Tdr</dev:code> <dev:remarks> <maml:para>Creates a session to AzureAD with a seperate pop up window promting for credentials Creates a session to MicrosoftTeams prompting for selection of existing loed in sessions</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/smarbar/MSTeamsDirectRouting/tree/main/docs/Connect-Tdr.md</maml:linkText> <maml:uri>https://github.com/smarbar/MSTeamsDirectRouting/tree/main/docs/Connect-Tdr.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/smarbar/MSTeamsDirectRouting/tree/main/docs</maml:linkText> <maml:uri>https://github.com/smarbar/MSTeamsDirectRouting/tree/main/docs</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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>Disable-TdrUser</command:name> <command:verb>Disable</command:verb> <command:noun>TdrUser</command:noun> <maml:description> <maml:para>Disbale voice on a user</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Disbales EnterpriseVoice and HostedVoicemail on a user</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-TdrUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Username</maml:name> <maml:description> <maml:para>Required. UserPrincipalName or LoginName of the Office365 User</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="True (ByValue)" position="0" aliases="none"> <maml:name>Username</maml:name> <maml:description> <maml:para>Required. UserPrincipalName or LoginName of the Office365 User</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:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This CmdLet can be used to disbale voice on a user</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Disable-TdrUser [-Username] name@domain.com</dev:code> <dev:remarks> <maml:para>Disables EnterpriseVoice and HostedVoicemail on a user</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/smarbar/MSTeamsDirectRouting/tree/main/docs/Disable-TdrUser.md</maml:linkText> <maml:uri>https://github.com/smarbar/MSTeamsDirectRouting/tree/main/docs/Disable-TdrUser.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/smarbar/MSTeamsDirectRouting/tree/main/docs</maml:linkText> <maml:uri>https://github.com/smarbar/MSTeamsDirectRouting/tree/main/docs</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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>Disconnect-Tdr</command:name> <command:verb>Disconnect</command:verb> <command:noun>Tdr</command:noun> <maml:description> <maml:para>Disconnect both AzureAD and Teams sessions</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Disconnects any open AzureAD and Microsoft Teams Sessions</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-Tdr</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This CmdLet can be used to disconnect the sessions to: AzureAD and MicrosoftTeams</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Disconnect-Tdr</dev:code> <dev:remarks> <maml:para>Disconnects from AzureAD, MicrosoftTeams Errors and Warnings are suppressed as no verification of existing sessions is undertaken</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/smarbar/MSTeamsDirectRouting/tree/main/docs/Disconnect-Tdr.md</maml:linkText> <maml:uri>https://github.com/smarbar/MSTeamsDirectRouting/tree/main/docs/Disconnect-Tdr.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/smarbar/MSTeamsDirectRouting/tree/main/docs</maml:linkText> <maml:uri>https://github.com/smarbar/MSTeamsDirectRouting/tree/main/docs</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <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>Enable-TdrResourceAccount</command:name> <command:verb>Enable</command:verb> <command:noun>TdrResourceAccount</command:noun> <maml:description> <maml:para>{{ Fill in the Synopsis }}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-TdrResourceAccount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Username</maml:name> <maml:description> <maml:para>{{ Fill Username Description }}</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="True (ByValue)" position="1" aliases="none"> <maml:name>DDI</maml:name> <maml:description> <maml:para>{{ Fill DDI Description }}</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="True (ByValue)" position="1" aliases="none"> <maml:name>DDI</maml:name> <maml:description> <maml:para>{{ Fill DDI Description }}</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="True (ByValue)" position="0" aliases="none"> <maml:name>Username</maml:name> <maml:description> <maml:para>{{ Fill Username Description }}</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:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </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>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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>Enable-TdrUser</command:name> <command:verb>Enable</command:verb> <command:noun>TdrUser</command:noun> <maml:description> <maml:para>{{ Fill in the Synopsis }}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-TdrUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Username</maml:name> <maml:description> <maml:para>{{ Fill Username Description }}</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="True (ByValue)" position="1" aliases="none"> <maml:name>DDI</maml:name> <maml:description> <maml:para>{{ Fill DDI Description }}</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="True (ByValue)" position="1" aliases="none"> <maml:name>DDI</maml:name> <maml:description> <maml:para>{{ Fill DDI Description }}</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="True (ByValue)" position="0" aliases="none"> <maml:name>Username</maml:name> <maml:description> <maml:para>{{ Fill Username Description }}</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:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </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>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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>New-TdrRoutingSetup</command:name> <command:verb>New</command:verb> <command:noun>TdrRoutingSetup</command:noun> <maml:description> <maml:para>Disconnect both AzureAD and Teams sessions</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Disconnects any open AzureAD and Microsoft Teams Sessions</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-TdrRoutingSetup</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This CmdLet can be used to disconnect the sessions to: AzureAD and MicrosoftTeams</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Disconnect-Tdr</dev:code> <dev:remarks> <maml:para>Disconnects from AzureAD, MicrosoftTeams Errors and Warnings are suppressed as no verification of existing sessions is undertaken</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/smarbar/MSTeamsDirectRouting/tree/main/docs/New-TdrRoutingSetup.md</maml:linkText> <maml:uri>https://github.com/smarbar/MSTeamsDirectRouting/tree/main/docs/New-TdrRoutingSetup.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/smarbar/MSTeamsDirectRouting/tree/main/docs</maml:linkText> <maml:uri>https://github.com/smarbar/MSTeamsDirectRouting/tree/main/docs</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |