en-US/MicrosoftHealth.psm1-Help.xml
|
<?xml version="1.0" encoding="utf-8"?><helpItems schema="maml">
<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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-MicrosoftHealthActivity</command:name> <maml:description> <maml:para>Gets Microsoft Band Activity</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb></command:verb> <command:noun></command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Activity object represents activities a user has completed using the tiles on the Microsoft Band. The following activities can be retrieved: - Run - Bike - Free Play (Workout) - Guided Workout - Golf - Sleep</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-MicrosoftHealthActivity</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>activity</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>StartTime</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>EndTime</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Details</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MapPoints</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MinuteSummaries</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>activity</maml:name> <maml: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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>StartTime</maml:name> <maml: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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2"> <maml:name>EndTime</maml:name> <maml: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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Details</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MapPoints</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MinuteSummaries</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml: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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-MicrosoftHealthActivity -Activity Run</dev:code> <dev:remarks> <maml:para>Gets collection of Run Activities</maml:para> <maml:para /> <maml:para /> <maml:para>activityType : Run performanceSummary : @{finishHeartRate=188; heartRateZones=} distanceSummary : @{period=Activity; totalDistance=552745; actualDistance=552957; elevationGain=2500; elevationLoss=2700; maxElevation=300; minElevation=-600; waypointDistance=2500; pace=371116} splitDistance : 160934 id : 2519507490576132521 startTime : 2015-12-31T08:49:02.386+00:00 endTime : 2015-12-31T09:23:13.386+00:00 dayId : 2015-12-31T00:00:00.000+00:00 duration : PT34M11S caloriesBurnedSummary : @{period=Activity; totalCalories=518} heartRateSummary : @{period=Activity; averageHeartRate=165; peakHeartRate=195; lowestHeartRate=72}</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-MicrosoftHealthActivity -Activity Bike</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-MicrosoftHealthActivity -activity Run -Details -MapPoints -MinuteSummaries</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para>activityType : Run activitySegments : {@{segmentId=635871485423867478; startTime=2015-12-31T08:49:02.386+00:00; endTime=2015-12-31T08:58:31.386+00:00; duration=PT9M29S; heartRateSummary=; caloriesBurnedSummary=; segmentType=Run}, @{segmentId=635871491118373752; startTime=2015-12-31T08:58:31.837+00:00; endTime=2015-12-31T09:10:04.837+00:00; duration=PT11M33S; heartRateSummary=; caloriesBurnedSummary=; segmentType=Run}, @{segmentId=635871498058250108; startTime=2015-12-31T09:10:05.825+00:00; endTime=2015-12-31T09:19:20.825+00:00; duration=PT9M15S; heartRateSummary=; caloriesBurnedSummary=; segmentType=Run}, @{segmentId=635871503619089263; startTime=2015-12-31T09:19:21.908+00:00; endTime=2015-12-31T09:23:13.908+00:00; duration=PT3M52S; heartRateSummary=; caloriesBurnedSummary=; segmentType=Run}} performanceSummary : @{finishHeartRate=188; heartRateZones=} distanceSummary : @{period=Activity; totalDistance=552745; actualDistance=552957; elevationGain=2500; elevationLoss=2700; maxElevation=300; minElevation=-600; waypointDistance=2500; pace=371116} splitDistance : 160934 mapPoints : {@{mapPointType=Start; ordinal=0; heartRate=97; pace=2222000; speed=45; isPaused=False; isResume=False}, @{secondsSinceStart=17; mapPointType=Waypoint; ordinal=1; actualDistance=2636; totalDistance=2636; heartRate=97; pace=526000; scaledPace=2; speed=190; location=; isPaused=False; isResume=False}, @{secondsSinceStart=25; mapPointType=Waypoint; ordinal=2; actualDistance=5082; totalDistance=5082; heartRate=97; pace=375000; scaledPace=13; speed=266; location=; isPaused=False; isResume=False}, @{secondsSinceStart=32; mapPointType=Waypoint; ordinal=3; actualDistance=7515; totalDistance=7515; heartRate=97; pace=342000; scaledPace=59; speed=292; location=; isPaused=False; isResume=False}...} id : 2519507490576132521 startTime : 2015-12-31T08:49:02.386+00:00 endTime : 2015-12-31T09:23:13.386+00:00 dayId : 2015-12-31T00:00:00.000+00:00 duration : PT34M11S minuteSummaries : {@{userId=a254gg98-9e56-234e-96a4-b5a71f775abc; startTime=2015-12-31T09:23:00.000+00:00; endTime=2015-12-31T09:24:00.000+00:00; parentDay=0001-01-01T00:00:00.000+00:00; isTransitDay=False; period=Minute; duration=PT1M; stepsTaken=178; caloriesBurnedSummary=; heartRateSummary=; distanceSummary=}, @{userId=a254gg98-9e56-234e-96a4-b5a71f775abc; startTime=2015-12-31T09:22:00.000+00:00; endTime=2015-12-31T09:23:00.000+00:00; parentDay=0001-01-01T00:00:00.000+00:00; isTransitDay=False; period=Minute; duration=PT1M; stepsTaken=182; caloriesBurnedSummary=; heartRateSummary=; distanceSummary=}, @{userId=a254gg98-9e56-234e-96a4-b5a71f775abc; startTime=2015-12-31T09:21:00.000+00:00; endTime=2015-12-31T09:22:00.000+00:00; parentDay=0001-01-01T00:00:00.000+00:00; isTransitDay=False; period=Minute; duration=PT1M; stepsTaken=182; caloriesBurnedSummary=; heartRateSummary=; distanceSummary=}, @{userId=a254gg98-9e56-234e-96a4-b5a71f775abc; startTime=2015-12-31T09:20:00.000+00:00; endTime=2015-12-31T09:21:00.000+00:00; parentDay=0001-01-01T00:00:00.000+00:00; isTransitDay=False; period=Minute; duration=PT1M; stepsTaken=184; caloriesBurnedSummary=; heartRateSummary=; distanceSummary=}...} caloriesBurnedSummary : @{period=Activity; totalCalories=518} heartRateSummary : @{period=Activity; averageHeartRate=165; peakHeartRate=195; lowestHeartRate=72}</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-MicrosoftHealthActivity -activity Run -Details -StartTime 10-01-2015 -EndTime 10-28-2015</dev:code> <dev:remarks> <maml:para>Returns all Run Activities with Detailed information between dates 10-01-2015 and 10-28-2015</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-MicrosoftHealthActivity -activity Run -OutVariable run $run | select-object *,@{L='totalCalories';E={$_.caloriesburnedsummary.totalcalories}} | sort-object -Property totalCalories -Descending | select-object -First 1</dev:code> <dev:remarks> <maml:para>Retrieve Best Burn (total calories burned) for Run Activity</maml:para> <maml:para /> <maml:para /> <maml:para>ActivityType : Run performanceSummary : @{heartRateZones=} distanceSummary : @{period=Activity; totalDistance=826707; actualDistance=826707; elevationGain=5400; elevationLoss=4900; maxElevation=500; minElevation=-300; waypointDistance=2500; pace=609017} splitDistance : 160934 id : 2519547244055907113 startTime : 2015-11-15T08:33:14.409+00:00 endTime : 2015-11-15T09:57:08.409+00:00 dayId : 2015-11-15T00:00:00.000+00:00 duration : PT1H23M54S caloriesBurnedSummary : @{period=Activity; totalCalories=1122} heartRateSummary : @{period=Activity; averageHeartRate=158; peakHeartRate=189; lowestHeartRate=77} totalCalories : 1122</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-MicrosoftHealthActivity -activity Run -OutVariable run $run | select-object *,@{L='pace';E={$_.distanceSummary.pace}} | sort-object -Property pace | select-object -First 1</dev:code> <dev:remarks> <maml:para>Retrieve Best Average Pace for Run Activity</maml:para> <maml:para /> <maml:para /> <maml:para>activityType : Run performanceSummary : @{finishHeartRate=173; heartRateZones=} distanceSummary : @{period=Activity; totalDistance=762962; actualDistance=763173; elevationGain=5700; elevationLoss=5600; maxElevation=1800; minElevation=200; waypointDistance=2500; pace=319958} splitDistance : 160934 id : 2519523864144954331 startTime : 2015-12-12T09:59:45.504+00:00 endTime : 2015-12-12T10:40:26.504+00:00 dayId : 2015-12-12T00:00:00.000+00:00 name : 7.6 km van Egmond duration : PT40M41S caloriesBurnedSummary : @{period=Activity; totalCalories=433} heartRateSummary : @{period=Activity; averageHeartRate=183; peakHeartRate=184; lowestHeartRate=70} pace : 319958</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft Health Cloud API V1</maml:linkText> <maml:uri>http://developer.microsoftband.com/cloudAPI/Explorer#!/Activities/Activities_Get</maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-MicrosoftHealthDevice</command:name> <maml:description> <maml:para>Gets Microsoft Band Device information</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb></command:verb> <command:noun></command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Device object represents a device that collects and sends user data to the Microsoft Health service</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-MicrosoftHealthDevice</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml: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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-MicrosoftHealthDevice</dev:code> <dev:remarks> <maml:para /> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft Health Cloud API V1</maml:linkText> <maml:uri>http://developer.microsoftband.com/cloudAPI/Explorer#!/Devices/Devices_Get</maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-MicrosoftHealthProfile</command:name> <maml:description> <maml:para>Gets the UserProfile.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb></command:verb> <command:noun></command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The UserProfile object contains the general profile of the person using Microsoft Band.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-MicrosoftHealthProfile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml: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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-MicrosoftHealthProfile</dev:code> <dev:remarks> <maml:para>Get the details about this user from their Microsoft Health profile</maml:para> <maml:para /> <maml:para /> <maml:para>firstName : John middleName : null lastName : Doe birthdate : 1970-01-01T00:00:00.000+00:00 postalCode : gender : Male height : 1680 weight : 72000 lastUpdateTime : 2015-10-28T19:43:27.123+00:00</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft Health Cloud API V1</maml:linkText> <maml:uri>http://developer.microsoftband.com/cloudAPI/Explorer#!/Profile/Profile_Get</maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-MicrosoftHealthSummary</command:name> <maml:description> <maml:para>Gets summarized data</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb></command:verb> <command:noun></command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Provides a sum-up of user data on an hourly or daily basis. This data is divided into several sub-groups: - Steps The total number of steps taken in the time period - Calories Burned The total calories burned in the time period - Heart Rate The average, peak, and lowest heart rate in the time period - Distance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-MicrosoftHealthSummary</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Period</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>maxPageSize</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Period</maml:name> <maml: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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>StartTime</maml:name> <maml: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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>EndTime</maml:name> <maml: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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>maxPageSize</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationAction</maml:name> <maml:description> <maml:para /> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri/> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>InformationVariable</maml:name> <maml: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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-MicrosoftHealthSummary -Period Daily</dev:code> <dev:remarks> <maml:para>Gets a summary of Daily data on a Daily basis</maml:para> <maml:para /> <maml:para /> <maml:para>userId : a123rr67-9c56-419e-95a4-b5a71f775abc startTime : 2015-12-30T00:00:00.000+00:00 endTime : 2015-12-31T00:00:00.000+00:00 parentDay : 2015-12-30T00:00:00.000+00:00 isTransitDay : False period : Daily duration : P1D stepsTaken : 9716 caloriesBurnedSummary : @{period=Daily; totalCalories=1860} heartRateSummary : @{period=Daily; averageHeartRate=72; peakHeartRate=97; lowestHeartRate=53} distanceSummary : @{period=Daily; totalDistance=763162; totalDistanceOnFoot=763162}</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-MicrosoftHealthSummary -Period Hourly</dev:code> <dev:remarks> <maml:para>Gets a summary of Daily data on a Hourly basis</maml:para> <maml:para /> <maml:para /> <maml:para>userId : a123rr67-9c56-419e-95a4-b5a71f775abc startTime : 2015-12-31T14:00:00.000+00:00 endTime : 2015-12-31T15:00:00.000+00:00 parentDay : 2015-12-31T00:00:00.000+00:00 isTransitDay : False period : Hourly duration : PT1H stepsTaken : 0 caloriesBurnedSummary : @{period=Hourly} heartRateSummary : @{period=Hourly} distanceSummary : @{period=Hourly}</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-MicrosoftHealthSummary -Period Hourly -StartTime 10-01-2015 -EndTime 10-10-2015 -maxPageSize 1</dev:code> <dev:remarks> <maml:para>Gets a summary overview of the Hourly data from 1st of October 2015 till 10th of October 2015 with page size of 1</maml:para> <maml:para /> <maml:para /> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Microsoft Health Cloud API V1</maml:linkText> <maml:uri>http://developer.microsoftband.com/cloudAPI/Explorer#!/Summaries/Summaries_Get</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |