PSIoTDevice

0.0.10

en-US/PSIoTDevice.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>New-DPSGroupDevice</command:name>
      <command:verb>New</command:verb>
      <command:noun>DPSGroupDevice</command:noun>
      <maml:description>
        <maml:para>Create a new device for Azure DPS Group</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Use this cmdlet to create a new device in an Azure DPS Group with a symmetric key</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>New-DPSGroupDevice</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none">
          <maml:name>UniqueDeviceId</maml:name>
          <maml:description>
            <maml:para>Unique name of the device to add to the DPS group</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="1" aliases="none">
          <maml:name>DPSGroupSymmetricKey</maml:name>
          <maml:description>
            <maml:para>The symmetric key of the DPS group</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="2" aliases="none">
          <maml:name>DPSIdScope</maml:name>
          <maml:description>
            <maml:para>IdScope of the DPS group</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="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none">
          <maml:name>GlobalDeviceEndpoint</maml:name>
          <maml:description>
            <maml:para>Global Device Endpoint - defaults to global.azure-devices-provisioning.net</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="1" aliases="none">
        <maml:name>DPSGroupSymmetricKey</maml:name>
        <maml:description>
          <maml:para>The symmetric key of the DPS group</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="2" aliases="none">
        <maml:name>DPSIdScope</maml:name>
        <maml:description>
          <maml:para>IdScope of the DPS group</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="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none">
        <maml:name>GlobalDeviceEndpoint</maml:name>
        <maml:description>
          <maml:para>Global Device Endpoint - defaults to global.azure-devices-provisioning.net</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 (ByPropertyName, ByValue)" position="0" aliases="none">
        <maml:name>UniqueDeviceId</maml:name>
        <maml:description>
          <maml:para>Unique name of the device to add to the DPS group</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:\&gt; New-DPSGroupDevice -UniqueDeviceId MyDevice -DPSGroupSymmetricKey 8WTOWMMuavYVaJ666vwmMbt3S+YfVuPnC+8y6Q9Icz7pdTD2a29Y+FrAslOxk5rYankO44+GT0SYF0ti0X/LXw== -DPSIdScope 0ne666ECA63</dev:code>
        <dev:remarks>
          <maml:para>DeviceId DeviceSecret AssignedHub -------- ------------ ----------- MyDevice Otkmz/0AgWtwt3u+GKpI666gks5RocNtuJ7AYWIBd8s= my-iot-hub.azure-devices.net</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>PS C:\&gt; $params = @{
    DPSIdScope = '0ne666ECA63'
    DPSGroupSymmetricKey = '8WTOWMMuavYVaJ666vwmMbt3S+YfVuPnC+8y6Q9Icz7pdTD2a29Y+FrAslOxk5rYankO44+GT0SYF0ti0X/LXw=='
    UniqueDeviceId = 'MyDevice'
}
PS C:\&gt; $Device = New-DPSGroupDevice @params
PS C:\&gt; $Device.SendMessage("This message came from my PowerShell device")</dev:code>
        <dev:remarks>
          <maml:para>Returns:</maml:para>
          <maml:para>Task completed successfully: True</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks />
  </command:command>
</helpItems>