﻿<?xml version="1.0" encoding="utf-8" ?>
<helpItems xmlns="http://msh" 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">
    <command:details>
      <command:name>
        Set-RoleInstanceStatus
      </command:name>
      <maml:description>
        <maml:para>Updates the role health status.</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para></maml:para>
      </maml:copyright>
      <command:verb>Set</command:verb>
      <command:noun>RoleInstanceStatus</command:noun>
      <dev:version></dev:version>
    </command:details>
    <maml:description>
      <maml:para>The Set-RoleHealthStatus cmdlet changes the health status of the current role instance. Note that setting the role instance health status to Ready will only set the role instance's health status to Ready if all other processes using the service hosting runtime also report Ready. If only a single process reports a non-Ready status then the role will have that status.</maml:para>
    </maml:description>
    <!-- Cmdlet syntax section-->
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Set-RoleInstanceStatus</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>Busy</maml:name>
          <maml:description>
            <maml:para>Mark the current role instance as busy.</maml:para>
          </maml:description>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>Set-RoleInstanceStatus</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>Ready</maml:name>
          <maml:description>
            <maml:para>Mark the current role instance as ready.</maml:para>
          </maml:description>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <!-- Cmdlet parameter section  -->
    <command:parameters>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>Busy</maml:name>
        <maml:description>
          <maml:para>Mark the current role instance as busy.</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></dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>Ready</maml:name>
        <maml:description>
          <maml:para>Mark the current role instance as ready.</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></dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <!-- Input - Output section-->
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name></maml:name>
          <maml:uri/>
          <maml:description />
        </dev:type>
        <maml:description>
          <maml:para>
            <!-- description  -->

          </maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name></maml:name>
          <maml:uri />
          <maml:description />
        </dev:type>
        <maml:description>
          <maml:para>
            <!-- description  -->

          </maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <!-- Error section-->
    <command:terminatingErrors />
    <command:nonTerminatingErrors />
    <!-- Notes section  -->
    <maml:alertSet>
      <maml:title></maml:title>
      <maml:alert>
        <maml:para>
          The current role instance's health status will only be changed for the duration of the Powershell session that the Set-RoleHealthStatus cmdlet was executed in. After the session ends, the health status set by any Set-RoleHealthStatus cmdlets in that session will no longer take effect.
        </maml:para>
      </maml:alert>
      <maml:alert>
        <maml:para></maml:para>
      </maml:alert>
    </maml:alertSet>
    <!-- Example section  -->
    <command:examples>
    </command:examples>
    <!-- Link section  -->
    <maml:relatedLinks>
      <maml:navigationLink>
        <maml:linkText></maml:linkText>
        <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">
    <command:details>
      <command:name>
        Get-ConfigurationSetting
      </command:name>
      <maml:description>
        <maml:para>Retrieves the value of a configuration setting.</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para></maml:para>
      </maml:copyright>
      <command:verb>Get</command:verb>
      <command:noun>ConfigurationSetting</command:noun>
      <dev:version></dev:version>
    </command:details>
    <maml:description>
      <maml:para>The Get-ConfigurationSetting cmdlet retrieves the value of a configuration setting set in the service's confguration.</maml:para>
    </maml:description>
    <!-- Cmdlet syntax section-->
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-ConfigurationSetting</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1">
          <maml:name>Name</maml:name>
          <maml:description>
            <maml:para>The name of the configuration setting to retrieve.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">string</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <!-- Cmdlet parameter section  -->
    <command:parameters>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1">
        <maml:name>Name</maml:name>
        <maml:description>
          <maml:para>The name of the configuration setting to retrieve.</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>
    <!-- Input - Output section-->
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name></maml:name>
          <maml:uri/>
          <maml:description />
        </dev:type>
        <maml:description>
          <maml:para>
            <!-- description  -->

          </maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
          <maml:description />
        </dev:type>
        <maml:description>
          <maml:para>
            <!-- description  -->

          </maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <!-- Error section-->
    <command:terminatingErrors />
    <command:nonTerminatingErrors />
    <!-- Notes section  -->
    <maml:alertSet>
      <maml:title></maml:title>
      <maml:alert>
        <maml:para>
          Enumeration of configuration settings is not supported.
        </maml:para>
      </maml:alert>
      <maml:alert>
        <maml:para></maml:para>
      </maml:alert>
    </maml:alertSet>
    <!-- Example section  -->
    <command:examples>
    </command:examples>
    <!-- Link section  -->
    <maml:relatedLinks>
      <maml:navigationLink>
        <maml:linkText></maml:linkText>
        <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">
    <command:details>
      <command:name>
        Get-LocalResource
      </command:name>
      <maml:description>
        <maml:para>Retrieves information about the specified local resource.</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para></maml:para>
      </maml:copyright>
      <command:verb>Get</command:verb>
      <command:noun>LocalResource</command:noun>
      <dev:version></dev:version>
    </command:details>
    <maml:description>
      <maml:para>The Get-LocalResource cmdlet retrieves information about a given local resource. The local resource name is the same as the one specified in the service definition for the role.</maml:para>
    </maml:description>
    <!-- Cmdlet syntax section-->
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-LocalResource</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1">
          <maml:name>Name</maml:name>
          <maml:description>
            <maml:para>The name of the local resource to retrieve.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">string</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <!-- Cmdlet parameter section  -->
    <command:parameters>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1">
        <maml:name>Name</maml:name>
        <maml:description>
          <maml:para>The name of the local resource to retrieve.</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>
    <!-- Input - Output section-->
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name></maml:name>
          <maml:uri/>
          <maml:description />
        </dev:type>
        <maml:description>
          <maml:para>
            <!-- description  -->

          </maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>Microsoft.WindowsAzure.ServiceRuntime.LocalResource</maml:name>
          <maml:uri />
          <maml:description />
        </dev:type>
        <maml:description>
          <maml:para>
            <!-- description  -->
            Type: Microsoft.WindowsAzure.ServiceRuntime.LocalResource

            Description: Represents a local storage resource reserved for a service.

            Name Property System.String

            MaximumSizeInMegabytes System.Int32

            RootPath System.String
          </maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <!-- Error section-->
    <command:terminatingErrors />
    <command:nonTerminatingErrors />
    <!-- Notes section  -->
    <maml:alertSet>
      <maml:title></maml:title>
      <maml:alert>
        <maml:para>
          Enumerating local resources is not currently supported.
        </maml:para>
      </maml:alert>
      <maml:alert>
        <maml:para></maml:para>
      </maml:alert>
    </maml:alertSet>
    <!-- Example section  -->
    <command:examples>
    </command:examples>
    <!-- Link section  -->
    <maml:relatedLinks>
      <maml:navigationLink>
        <maml:linkText></maml:linkText>
        <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">
    <command:details>
      <command:name>
        Get-RoleInstance
      </command:name>
      <maml:description>
        <maml:para>Retrieve role instance information such as endpoints and instance IDs.</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para></maml:para>
      </maml:copyright>
      <command:verb>Get</command:verb>
      <command:noun>RoleInstance</command:noun>
      <dev:version></dev:version>
    </command:details>
    <maml:description>
      <maml:para>The Get-RoleInstance cmdlet retrieves information about role instances, including endpoint details and instance IDs. By default the cmdlet returns a list of all known instances of every role, but this list can be filtered by role name using the RoleName parameter.</maml:para>
    </maml:description>
    <!-- Cmdlet syntax section-->
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-RoleInstance</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named">
          <maml:name>Role</maml:name>
          <maml:description>
            <maml:para>The name of the role whose instances are to be retrieved.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">string</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>Get-RoleInstance</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>Current</maml:name>
          <maml:description>
            <maml:para>When set, return only the current role instance.</maml:para>
          </maml:description>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <!-- Cmdlet parameter section  -->
    <command:parameters>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>Current</maml:name>
        <maml:description>
          <maml:para>When set, return only the current role instance.</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></dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named">
        <maml:name>Role</maml:name>
        <maml:description>
          <maml:para>The name of the role whose instances are to be retrieved.</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>
    <!-- Input - Output section-->
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name></maml:name>
          <maml:uri/>
          <maml:description />
        </dev:type>
        <maml:description>
          <maml:para>
            <!-- description  -->

          </maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>Microsoft.WindowsAzure.ServiceRuntime.RoleInstance</maml:name>
          <maml:uri />
          <maml:description />
        </dev:type>
        <maml:description>
          <maml:para>
            <!-- description  -->
            Type: Microsoft.WindowsAzure.ServiceRuntime.RoleInstance

            Description: A class that represents an instance of a role.

            When Output: Output when role instances match the criteria in the parameters.

            Id Property System.String

            Role Property Microsoft.WindowsAzure.ServiceRuntime.Role

            FaultDomain Property System.Int32

            UpdateDomain Property System.Int32

            InstanceEndpoints Property System.Collections.Generic.IDictionary&lt;System.String, Microsoft.WindowsAzure.ServiceRuntime.RoleInstanceEndpoint&gt;
          </maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <!-- Error section-->
    <command:terminatingErrors />
    <command:nonTerminatingErrors />
    <!-- Notes section  -->
    <maml:alertSet>
      <maml:title></maml:title>
      <maml:alert>
        <maml:para>
          Only instances that have an internal or input endpoint will be returned. If the current role instance does not define any internal or input endpoints then only the current instance will be shown for role the current instance belongs to.
        </maml:para>
      </maml:alert>
      <maml:alert>
        <maml:para></maml:para>
      </maml:alert>
    </maml:alertSet>
    <!-- Example section  -->
    <command:examples>

      <command:example>
        <maml:title>
          -------------------------- EXAMPLE 1 --------------------------
        </maml:title>
        <maml:introduction>
          <maml:para>C:\PS&gt;</maml:para>
        </maml:introduction>
        <dev:code>
          Get-RoleInstance
        </dev:code>
        <dev:remarks>
          <maml:para>Description</maml:para>
          <maml:para>-----------</maml:para>
          <maml:para>This command retrieves details on all the known role instances in the deployment.</maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText></command:commandText>
          </command:commandLine>
        </command:commandLines>
      </command:example>

      <command:example>
        <maml:title>
          -------------------------- EXAMPLE 2 --------------------------
        </maml:title>
        <maml:introduction>
          <maml:para>C:\PS&gt;</maml:para>
        </maml:introduction>
        <dev:code>
          Get-RoleInstance -Current
        </dev:code>
        <dev:remarks>
          <maml:para>Description</maml:para>
          <maml:para>-----------</maml:para>
          <maml:para>This command retrieves details on the current role instance.</maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText></command:commandText>
          </command:commandLine>
        </command:commandLines>
      </command:example>

      <command:example>
        <maml:title>
          -------------------------- EXAMPLE 3 --------------------------
        </maml:title>
        <maml:introduction>
          <maml:para>C:\PS&gt;</maml:para>
        </maml:introduction>
        <dev:code>
          Get-RoleInstance WorkerRole1_IN_2
        </dev:code>
        <dev:remarks>
          <maml:para>Description</maml:para>
          <maml:para>-----------</maml:para>
          <maml:para>This command retrieves details on the instance with the ID &quot;WorkerRole1_IN_2&quot;.</maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText></command:commandText>
          </command:commandLine>
        </command:commandLines>
      </command:example>

      <command:example>
        <maml:title>
          -------------------------- EXAMPLE 4 --------------------------
        </maml:title>
        <maml:introduction>
          <maml:para>C:\PS&gt;</maml:para>
        </maml:introduction>
        <dev:code>
          Get-RoleInstance -Role WorkerRole1
        </dev:code>
        <dev:remarks>
          <maml:para>Description</maml:para>
          <maml:para>-----------</maml:para>
          <maml:para>This command retrieves details on all the instances of the role &quot;WorkerRole1&quot;.</maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
          <maml:para></maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText></command:commandText>
          </command:commandLine>
        </command:commandLines>
      </command:example>
    </command:examples>
    <!-- Link section  -->
    <maml:relatedLinks>
      <maml:navigationLink>
        <maml:linkText></maml:linkText>
        <maml:uri/>
      </maml:navigationLink>
    </maml:relatedLinks>
  </command:command>
</helpItems>