NfsMountConfiguration.xml

<Type Name="NfsMountConfiguration" FullName="Microsoft.Azure.Batch.NfsMountConfiguration">
  <TypeSignature Language="C#" Value="public class NfsMountConfiguration" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit NfsMountConfiguration extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.NfsMountConfiguration" />
  <TypeSignature Language="VB.NET" Value="Public Class NfsMountConfiguration" />
  <TypeSignature Language="F#" Value="type NfsMountConfiguration = class" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Batch</AssemblyName>
    <AssemblyVersion>14.0.0.0</AssemblyVersion>
    <AssemblyVersion>15.0.0.0</AssemblyVersion>
    <AssemblyVersion>15.1.0.0</AssemblyVersion>
    <AssemblyVersion>15.3.0.0</AssemblyVersion>
    <AssemblyVersion>15.4.0.0</AssemblyVersion>
    <AssemblyVersion>16.0.0.0</AssemblyVersion>
    <AssemblyVersion>16.1.0.0</AssemblyVersion>
    <AssemblyVersion>16.2.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Information used to connect to an NFS file system.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public NfsMountConfiguration (string source, string relativeMountPath, string mountOptions = default);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string source, string relativeMountPath, string mountOptions) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.NfsMountConfiguration.#ctor(System.String,System.String,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (source As String, relativeMountPath As String, Optional mountOptions As String = Nothing)" />
      <MemberSignature Language="F#" Value="new Microsoft.Azure.Batch.NfsMountConfiguration : string * string * string -&gt; Microsoft.Azure.Batch.NfsMountConfiguration" Usage="new Microsoft.Azure.Batch.NfsMountConfiguration (source, relativeMountPath, mountOptions)" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Batch</AssemblyName>
        <AssemblyVersion>16.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="source" Type="System.String" />
        <Parameter Name="relativeMountPath" Type="System.String" />
        <Parameter Name="mountOptions" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="source">The URI of the file system to mount.</param>
        <param name="relativeMountPath">The relative path on the compute node where the file system will be mounted.</param>
        <param name="mountOptions">Additional command line options to pass to the mount command.</param>
        <summary>
            Initializes a new instance of the <see cref="T:Microsoft.Azure.Batch.NfsMountConfiguration" /> class.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="MountOptions">
      <MemberSignature Language="C#" Value="public string MountOptions { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string MountOptions" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.NfsMountConfiguration.MountOptions" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property MountOptions As String" />
      <MemberSignature Language="F#" Value="member this.MountOptions : string" Usage="Microsoft.Azure.Batch.NfsMountConfiguration.MountOptions" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Batch</AssemblyName>
        <AssemblyVersion>16.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets additional command line options to pass to the mount command.
            </summary>
        <value>To be added.</value>
        <remarks>
            These are 'net use' options in Windows and 'mount' options in Linux.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="RelativeMountPath">
      <MemberSignature Language="C#" Value="public string RelativeMountPath { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string RelativeMountPath" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.NfsMountConfiguration.RelativeMountPath" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property RelativeMountPath As String" />
      <MemberSignature Language="F#" Value="member this.RelativeMountPath : string" Usage="Microsoft.Azure.Batch.NfsMountConfiguration.RelativeMountPath" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Batch</AssemblyName>
        <AssemblyVersion>16.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the relative path on the compute node where the file system will be mounted.
            </summary>
        <value>To be added.</value>
        <remarks>
            All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR 
            environment variable.
            </remarks>
      </Docs>
    </Member>
    <Member MemberName="Source">
      <MemberSignature Language="C#" Value="public string Source { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Source" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.NfsMountConfiguration.Source" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Source As String" />
      <MemberSignature Language="F#" Value="member this.Source : string" Usage="Microsoft.Azure.Batch.NfsMountConfiguration.Source" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Batch</AssemblyName>
        <AssemblyVersion>16.2.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the URI of the file system to mount.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>