MicrosoftTeamsRecordingPolicy

2.0.3

MicrosoftTeamsRecordingPolicy.psm1-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>Install-TeamsRecordingPolicy</command:name>

      <command:verb>Install</command:verb>

      <command:noun>TeamsRecordingPolicy</command:noun>

      <maml:description>

        <maml:para>Configures a compliance recording policy on a team.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>The Install-TeamsRecordingPolicy configures a compliance recording policy on a team.  Members of that team will have their Teams meetings and calls recorded upon consent.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Install-TeamsRecordingPolicy</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none">

          <maml:name>recordingPolicyName</maml:name>

          <maml:Description>

            <maml:para>Recording policy name.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.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="1" aliases="none">

          <maml:name>recordingPolicyDescription</maml:name>

          <maml:Description>

            <maml:para>Recording policy description.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.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="2" aliases="none">

          <maml:name>recorderUserPrincipal</maml:name>

          <maml:Description>

            <maml:para>The user principal name of the recorder application. If the user principal does not exist, it will be created.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.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="3" aliases="none">

          <maml:name>recorderUserPrincipalDisplayName</maml:name>

          <maml:Description>

            <maml:para>The display name of the recorder application.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.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="4" aliases="none">

          <maml:name>recorderApplicationId</maml:name>

          <maml:Description>

            <maml:para>The ID of the recorder application.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.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="4" aliases="none">

          <maml:name>teamName</maml:name>

          <maml:Description>

            <maml:para>The name of the team to which the recording policy will apply. If the team does not exist, it will be created.</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

          <dev:type>

            <maml:name>System.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="0" aliases="none">

        <maml:name>recordingPolicyName</maml:name>

        <maml:Description>

          <maml:para>Recording policy name.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.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="1" aliases="none">

        <maml:name>recordingPolicyDescription</maml:name>

        <maml:Description>

          <maml:para>Recording policy description.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.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="2" aliases="none">

        <maml:name>recorderUserPrincipal</maml:name>

        <maml:Description>

          <maml:para>The user principal name of the recorder application. If the user principal does not exist, it will be created.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.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="3" aliases="none">

        <maml:name>recorderUserPrincipalDisplayName</maml:name>

        <maml:Description>

          <maml:para>The display name of the recorder application.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.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="4" aliases="none">

        <maml:name>recorderApplicationId</maml:name>

        <maml:Description>

          <maml:para>The ID of the recorder application.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.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="4" aliases="none">

        <maml:name>teamName</maml:name>

        <maml:Description>

          <maml:para>The name of the team to which the recording policy will apply. If the team does not exist, it will be created.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.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:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------- Example: Install compliance recording policy--------</maml:title>

        <dev:code>PS C:\&gt; Install-TeamsRecordingPolicy -recordingPolicyName "Recording Policy" -recordingPolicyDescription "Recording policy for Contoso teams." -recorderUserPrincipal "recorder@contoso.com" -recorderUserPrincipalDisplayName "Contoso Recorder" -recorderApplicationId "55555555-5555-5555-5555-555555555555" -teamName "Contoso Sales"

Connecting to Teams...

Team 'Contoso Sales' not found. Creating a new team...

Getting group policy for 'Contoso Sales'...

Getting user principal 'recorder@contoso.com'...

User principal 'recorder@contoso.com' not found. Creating a new one...

Getting recording policy 'Recording Policy'...

Recording policy 'Recording Policy' not found. Creating a new one...

Applying policy 'Recording Policy' to 'Contoso Sales'...

Successfully assigned policy 'Recording Policy' to 'Contoso Sales'!</dev:code>

        <dev:remarks>

          <maml:para>This command creates a compliance recording policy named 'Recording Policy' and assigns it to the Contoso Sales team.</maml:para>

<maml:para></maml:para>

<maml:para></maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Teams Compliance Recording Policies</maml:linkText>

        <maml:uri>https://docs.microsoft.com/en-us/MicrosoftTeams/teams-recording-policy</maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

</helpItems>