CaPolice

0.0.3

CaPolice.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:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10">

    <command:details>

      <command:name>Connect-CaPolice</command:name>

      <command:verb>Connect</command:verb>

      <command:noun>CaPolice</command:noun>

      <maml:description>

        <maml:para>Connects to CaPolice to Graph.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>This cmdlet connects to CaPolice to Graph using the specified authentication method.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Connect-CaPolice</maml:name>

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

          <maml:name>Github</maml:name>

          <maml:description>

            <maml:para>

            Try connect to Graph using GitHub Actions workload identity.

            </maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none">

          <maml:name>TenantId</maml:name>

          <maml:description>

            <maml:para>

            Specify the Tenant ID for the authentication, is load from the environment variable AZURE_TENANT_ID if not specified.

            </maml:para>

          </maml:description>

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

          <dev:type>

            <maml:name>String</maml:name>

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">

          <maml:name>ClientId</maml:name>

          <maml:description>

            <maml:para>

            Specify the client ID for the authentication, is load from the environment variable AZURE_CLIENT_ID if not specified.

            </maml:para>

          </maml:description>

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

          <dev:type>

            <maml:name>String</maml:name>

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

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

          <maml:name>Test</maml:name>

          <maml:description>

            <maml:para>

            Test the connection by retrieving a token from Graph and output it to the console.

            </maml:para>

          </maml:description>

          <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

      <command:syntaxItem>

        <maml:name>Connect-CaPolice</maml:name>

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

          <maml:name>UseDefaultCredentials</maml:name>

          <maml:description>

            <maml:para>

            Try connect to Graph using DefaultAzureCredential.

            </maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none">

          <maml:name>TenantId</maml:name>

          <maml:description>

            <maml:para>

            Specify the Tenant ID for the authentication, is load from the environment variable AZURE_TENANT_ID if not specified.

            </maml:para>

          </maml:description>

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

          <dev:type>

            <maml:name>String</maml:name>

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">

          <maml:name>ClientId</maml:name>

          <maml:description>

            <maml:para>

            Specify the client ID for the authentication, is load from the environment variable AZURE_CLIENT_ID if not specified.

            </maml:para>

          </maml:description>

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

          <dev:type>

            <maml:name>String</maml:name>

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

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

          <maml:name>Test</maml:name>

          <maml:description>

            <maml:para>

            Test the connection by retrieving a token from Graph and output it to the console.

            </maml:para>

          </maml:description>

          <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

      <command:syntaxItem>

        <maml:name>Connect-CaPolice</maml:name>

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

          <maml:name>UseManagedIdentity</maml:name>

          <maml:description>

            <maml:para>

            Try connect to Graph using Managed Identity.

            </maml:para>

          </maml:description>

          <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

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

          <maml:name>Test</maml:name>

          <maml:description>

            <maml:para>

            Test the connection by retrieving a token from Graph and output it to the console.

            </maml:para>

          </maml:description>

          <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none">

        <maml:name>ClientId</maml:name>

        <maml:description>

          <maml:para>

            Specify the client ID for the authentication, is load from the environment variable AZURE_CLIENT_ID if not specified.

            </maml:para>

        </maml:description>

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

        <dev:type>

          <maml:name>String</maml:name>

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none">

        <maml:name>TenantId</maml:name>

        <maml:description>

          <maml:para>

            Specify the Tenant ID for the authentication, is load from the environment variable AZURE_TENANT_ID if not specified.

            </maml:para>

        </maml:description>

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

        <dev:type>

          <maml:name>String</maml:name>

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

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

        <maml:name>Github</maml:name>

        <maml:description>

          <maml:para>

            Try connect to Graph using GitHub Actions workload identity.

            </maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

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

        <maml:name>UseManagedIdentity</maml:name>

        <maml:description>

          <maml:para>

            Try connect to Graph using Managed Identity.

            </maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

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

        <maml:name>UseDefaultCredentials</maml:name>

        <maml:description>

          <maml:para>

            Try connect to Graph using DefaultAzureCredential.

            </maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

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

        <maml:name>Test</maml:name>

        <maml:description>

          <maml:para>

            Test the connection by retrieving a token from Graph and output it to the console.

            </maml:para>

        </maml:description>

        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.String</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>System.String</maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <command:examples>

      <command:example>

        <maml:title>----------------------  GitHub Actions workload identity  ----------------------</maml:title>

        <dev:code>PS C:\&gt; Connect-CaPolice -Github</dev:code>

        <dev:remarks>

          <maml:para>Connect to Graph using GitHub Actions workload identity.

</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

  </command:command>

</helpItems>