CloudMachine.xml

<Type Name="CloudMachine" FullName="Azure.CloudMachine">
  <TypeSignature Language="C#" Value="public class CloudMachine" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CloudMachine extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Azure.CloudMachine" />
  <TypeSignature Language="VB.NET" Value="Public Class CloudMachine" />
  <TypeSignature Language="F#" Value="type CloudMachine = class" />
  <AssemblyInfo>
    <AssemblyName>Azure.Core.Experimental</AssemblyName>
    <AssemblyVersion>0.1.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Stores configuration of a CloudMachine.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public CloudMachine (System.IO.Stream configurationContent);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Stream configurationContent) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.CloudMachine.#ctor(System.IO.Stream)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (configurationContent As Stream)" />
      <MemberSignature Language="F#" Value="new Azure.CloudMachine : System.IO.Stream -&gt; Azure.CloudMachine" Usage="new Azure.CloudMachine configurationContent" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Core.Experimental</AssemblyName>
        <AssemblyVersion>0.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="configurationContent" Type="System.IO.Stream" />
      </Parameters>
      <Docs>
        <param name="configurationContent" />
        <summary>
            Loads CloudMachine settings from stream.
            </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:Azure.CloudMachine.InvalidCloudMachineConfigurationException" />
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public CloudMachine (string? configurationFile = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string configurationFile) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.CloudMachine.#ctor(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (Optional configurationFile As String = Nothing)" />
      <MemberSignature Language="F#" Value="new Azure.CloudMachine : string -&gt; Azure.CloudMachine" Usage="new Azure.CloudMachine configurationFile" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Core.Experimental</AssemblyName>
        <AssemblyVersion>0.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="configurationFile" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="configurationFile">Default value is .azure\cloudmachine.json</param>
        <summary>
            Loads CloudMachine settings from configurationFile
            </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:Azure.CloudMachine.InvalidCloudMachineConfigurationException" />
      </Docs>
    </Member>
    <Member MemberName="Create">
      <MemberSignature Language="C#" Value="public static Azure.CloudMachine Create (string subscriptionId, string region);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.CloudMachine Create(string subscriptionId, string region) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.CloudMachine.Create(System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Shared Function Create (subscriptionId As String, region As String) As CloudMachine" />
      <MemberSignature Language="F#" Value="static member Create : string * string -&gt; Azure.CloudMachine" Usage="Azure.CloudMachine.Create (subscriptionId, region)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Core.Experimental</AssemblyName>
        <AssemblyVersion>0.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Azure.CloudMachine</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="subscriptionId" Type="System.String" />
        <Parameter Name="region" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="subscriptionId" />
        <param name="region" />
        <summary>
            Creates a new CloudMachine
            </summary>
        <returns />
        <remarks>DisplayName is initialized to id. It can be changed by setting the DisplayName property.</remarks>
      </Docs>
    </Member>
    <Member MemberName="DisplayName">
      <MemberSignature Language="C#" Value="public string DisplayName { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string DisplayName" />
      <MemberSignature Language="DocId" Value="P:Azure.CloudMachine.DisplayName" />
      <MemberSignature Language="VB.NET" Value="Public Property DisplayName As String" />
      <MemberSignature Language="F#" Value="member this.DisplayName : string with get, set" Usage="Azure.CloudMachine.DisplayName" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Core.Experimental</AssemblyName>
        <AssemblyVersion>0.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Friendly name of CloudMachine. It's stored as a Tag of all Azure resources associated with the machine.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Id">
      <MemberSignature Language="C#" Value="public string Id { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Id" />
      <MemberSignature Language="DocId" Value="P:Azure.CloudMachine.Id" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Id As String" />
      <MemberSignature Language="F#" Value="member this.Id : string" Usage="Azure.CloudMachine.Id" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Core.Experimental</AssemblyName>
        <AssemblyVersion>0.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Unique identifier of a CloudMachine. It's the name of the resource group of all the CloudMachine resources.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Region">
      <MemberSignature Language="C#" Value="public string Region { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Region" />
      <MemberSignature Language="DocId" Value="P:Azure.CloudMachine.Region" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Region As String" />
      <MemberSignature Language="F#" Value="member this.Region : string" Usage="Azure.CloudMachine.Region" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Core.Experimental</AssemblyName>
        <AssemblyVersion>0.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Azure region, e.g. westus2
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Save">
      <MemberSignature Language="C#" Value="public void Save (System.IO.Stream stream);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Save(class System.IO.Stream stream) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.CloudMachine.Save(System.IO.Stream)" />
      <MemberSignature Language="VB.NET" Value="Public Sub Save (stream As Stream)" />
      <MemberSignature Language="F#" Value="member this.Save : System.IO.Stream -&gt; unit" Usage="cloudMachine.Save stream" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Core.Experimental</AssemblyName>
        <AssemblyVersion>0.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="stream" Type="System.IO.Stream" />
      </Parameters>
      <Docs>
        <param name="stream" />
        <summary>
            Save CloudMachine configuration to a stream.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Save">
      <MemberSignature Language="C#" Value="public void Save (string filepath);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Save(string filepath) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.CloudMachine.Save(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub Save (filepath As String)" />
      <MemberSignature Language="F#" Value="member this.Save : string -&gt; unit" Usage="cloudMachine.Save filepath" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Core.Experimental</AssemblyName>
        <AssemblyVersion>0.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="filepath" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="filepath" />
        <summary>
            Save CloudMachine configuration to a file.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SubscriptionId">
      <MemberSignature Language="C#" Value="public string SubscriptionId { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string SubscriptionId" />
      <MemberSignature Language="DocId" Value="P:Azure.CloudMachine.SubscriptionId" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property SubscriptionId As String" />
      <MemberSignature Language="F#" Value="member this.SubscriptionId : string" Usage="Azure.CloudMachine.SubscriptionId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.Core.Experimental</AssemblyName>
        <AssemblyVersion>0.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Azure subscription ID.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>