Azure

1.6.0

Compute/Microsoft.WindowsAzure.Commands.ServiceManagement.Preview.dll-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>Invoke-AzureComputeMethod</command:name>
      <maml:description>
        <maml:para>This cmdlet calls the client library by -MethodName.</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para />
      </maml:copyright>
      <command:verb>Invoke</command:verb>
      <command:noun>AzureComputeMethod</command:noun>
      <dev:version />
    </command:details>
    <maml:description>
      <maml:para />
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Invoke-AzureComputeMethod</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0">
          <maml:name>MethodName</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>Profile</maml:name>
          <maml:description>
            <maml:para />
          </maml:description>
          <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>Invoke-AzureComputeMethod</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0">
          <maml:name>MethodName</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>Profile</maml:name>
          <maml:description>
            <maml:para />
          </maml:description>
          <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0">
        <maml:name>MethodName</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>Profile</maml:name>
        <maml:description>
          <maml:para />
        </maml:description>
        <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue>
        <dev:type>
          <maml:name>AzureProfile</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>
          </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:para>Keywords: azure, azuresm, servicemanagement, management, service, preview</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>-------------------------- Example 1 --------------------------</maml:title>
        <maml:introduction>
          <maml:paragraph>PS C:\&gt;</maml:paragraph>
        </maml:introduction>
        <dev:code>
        # Create Parameters
        $svcCreateParams = New-AzureComputeParameterObject -FriendlyName 'HostedServiceCreateParameters';
        $svcCreateParams.ServiceName = $svcName;
        $svcCreateParams.Location = $location;
        $svcCreateParams.Description = $svcName;
        $svcCreateParams.Label = $svcName;
 
        # Invoke Create
        $st = Invoke-AzureComputeMethod -MethodName 'HostedServiceCreate' -HostedServiceCreateParameters $svcCreateParams;
 
        Assert-AreEqual $st.StatusCode 'Created';
        Assert-NotNull $st.RequestId;
 
        # Invoke Get
        $svcGetResult = Invoke-AzureComputeMethod -MethodName 'HostedServiceGet' -ServiceName $svcName;
        Assert-AreEqual $svcGetResult.ServiceName $svcName;
        Assert-AreEqual $svcGetResult.Properties.Description $svcName;
        Assert-AreEqual $svcGetResult.Properties.Label $svcName;
 
        # Update Parameters
        $svcUpdateParams = New-AzureComputeParameterObject -FriendlyName 'HostedServiceUpdateParameters';
        $svcUpdateParams.Description = 'update1';
        $svcUpdateParams.Label = 'update2';
 
        # Invoke Update
        $svcGetResult2 = Invoke-AzureComputeMethod -MethodName 'HostedServiceUpdate' -ServiceName $svcName -HostedServiceUpdateParameters $svcUpdateParams;
 
        # Invoke Get
        $svcGetResult2 = Invoke-AzureComputeMethod -MethodName 'HostedServiceGet' -ServiceName $svcName;
        Assert-AreEqual $svcGetResult2.ServiceName $svcName;
        Assert-AreEqual $svcGetResult2.Properties.Description $svcUpdateParams.Description;
        Assert-AreEqual $svcGetResult2.Properties.Label $svcUpdateParams.Label;
 
        # Invoke List
        $svcListResult = Invoke-AzureComputeMethod -MethodName 'HostedServiceList';
        Assert-True { ($svcListResult | where { $_.ServiceName -eq $svcName }).Count -gt 0 };
 
        # Invoke Delete
        $st = Invoke-AzureComputeMethod -MethodName 'HostedServiceDelete' -ServiceName $svcName;
        Assert-AreEqual $st.StatusCode 'OK';
        Assert-NotNull $st.RequestId;</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: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>New-AzureComputeArgumentList</command:name>
      <maml:description>
        <maml:para>This cmdlet creates new argument lists by -MethodName that can be used as input of the Invoke-AzureComputeMethod cmdlet.</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para />
      </maml:copyright>
      <command:verb>New</command:verb>
      <command:noun>AzureComputeArgumentList</command:noun>
      <dev:version />
    </command:details>
    <maml:description>
      <maml:para />
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>New-AzureComputeArgumentList</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0">
          <maml:name>MethodName</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>Profile</maml:name>
          <maml:description>
            <maml:para />
          </maml:description>
          <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0">
        <maml:name>MethodName</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>Profile</maml:name>
        <maml:description>
          <maml:para />
        </maml:description>
        <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue>
        <dev:type>
          <maml:name>AzureProfile</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>
          </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:para>Keywords: azure, azuresm, servicemanagement, management, service, preview</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>-------------------------- Example 1 --------------------------</maml:title>
        <maml:introduction>
          <maml:paragraph>PS C:\&gt;</maml:paragraph>
        </maml:introduction>
        <dev:code>
    $command = Get-Command -Name 'New-AzureComputeArgumentList';
    $all_methods = $command.Parameters['MethodName'].Attributes.ValidValues;
 
    foreach ($method in $all_methods)
    {
        $args = New-AzureComputeArgumentList -MethodName $method;
        foreach ($arg in $args)
        {
            Assert-NotNull $arg;
        }
 
        Write-Verbose "Invoke-AzureComputeMethod -MethodName $method -ArgumentList $args;";
 
        if ($args.Count -gt 0)
        {
            # If the method requires any inputs, empty/null input call would fail
            Assert-Throws { Invoke-AzureComputeMethod -MethodName $method -ArgumentList $args; }
        }
        else
        {
            # If the method doesn't requires any inputs, it shall succeed.
            $st = Invoke-AzureComputeMethod -MethodName $method;
        }
    }</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: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>New-AzureComputeParameterObject</command:name>
      <maml:description>
        <maml:para>This cmdlet creates new parameter objects by -FriendlyName or -FullName of the types.</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para />
      </maml:copyright>
      <command:verb>New</command:verb>
      <command:noun>AzureComputeParameterObject</command:noun>
      <dev:version />
    </command:details>
    <maml:description>
      <maml:para />
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>New-AzureComputeParameterObject</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0">
          <maml:name>FullName</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>Profile</maml:name>
          <maml:description>
            <maml:para />
          </maml:description>
          <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>New-AzureComputeParameterObject</maml:name>
        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0">
          <maml:name>FriendlyName</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>Profile</maml:name>
          <maml:description>
            <maml:para />
          </maml:description>
          <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0">
        <maml:name>FullName</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>Profile</maml:name>
        <maml:description>
          <maml:para />
        </maml:description>
        <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue>
        <dev:type>
          <maml:name>AzureProfile</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>
        </dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0">
        <maml:name>FriendlyName</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>
          </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:para>Keywords: azure, azuresm, servicemanagement, management, service, preview</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>-------------------------- Example 1 --------------------------</maml:title>
        <maml:introduction>
          <maml:paragraph>PS C:\&gt;</maml:paragraph>
        </maml:introduction>
        <dev:code>
        $command = Get-Command -Name 'New-AzureComputeParameterObject';
 
        $all_friendly_names = $command.Parameters['FriendlyName'].Attributes.ValidValues;
        foreach ($friendly_name in $all_friendly_names)
        {
        $param = New-AzureComputeParameterObject -FriendlyName $friendly_name;
        Assert-NotNull $param;
        }
 
        $all_full_names = $command.Parameters['FullName'].Attributes.ValidValues;
        foreach ($full_name in $all_full_names)
        {
        $param = New-AzureComputeParameterObject -FullName $full_name;
        Assert-NotNull $param;
 
        $param_type_name = $param.GetType().ToString().Replace('+', '.');
        $full_name_query = $full_name.Replace('+', '.').Replace('&lt;', '*').Replace('&gt;', '*');
        Assert-True { $param_type_name -like $full_name_query } "`'$param_type_name`' &amp; `'$full_name`'";
        }
      </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:relatedLinks>
  </command:command>
</helpItems>