-
Notifications
You must be signed in to change notification settings - Fork 255
/
LinuxUserConfiguration.xml
152 lines (152 loc) · 8.53 KB
/
LinuxUserConfiguration.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
<Type Name="LinuxUserConfiguration" FullName="Microsoft.Azure.Batch.LinuxUserConfiguration">
<TypeSignature Language="C#" Value="public class LinuxUserConfiguration" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit LinuxUserConfiguration extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Batch.LinuxUserConfiguration" />
<TypeSignature Language="VB.NET" Value="Public Class LinuxUserConfiguration" />
<TypeSignature Language="F#" Value="type LinuxUserConfiguration = 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>
Properties used to create a user account on a Linux node.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected LinuxUserConfiguration ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.LinuxUserConfiguration.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Default constructor to support mocking the <see cref="T:Microsoft.Azure.Batch.LinuxUserConfiguration" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public LinuxUserConfiguration (int? uid = default, int? gid = default, string sshPrivateKey = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Nullable`1<int32> uid, valuetype System.Nullable`1<int32> gid, string sshPrivateKey) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Batch.LinuxUserConfiguration.#ctor(System.Nullable{System.Int32},System.Nullable{System.Int32},System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional uid As Nullable(Of Integer) = Nothing, Optional gid As Nullable(Of Integer) = Nothing, Optional sshPrivateKey As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Batch.LinuxUserConfiguration : Nullable<int> * Nullable<int> * string -> Microsoft.Azure.Batch.LinuxUserConfiguration" Usage="new Microsoft.Azure.Batch.LinuxUserConfiguration (uid, gid, sshPrivateKey)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="uid" Type="System.Nullable<System.Int32>" />
<Parameter Name="gid" Type="System.Nullable<System.Int32>" />
<Parameter Name="sshPrivateKey" Type="System.String" />
</Parameters>
<Docs>
<param name="uid">The user ID of the user account.</param>
<param name="gid">The group ID of the user account.</param>
<param name="sshPrivateKey">The SSH private key for the user account.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Batch.LinuxUserConfiguration" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Gid">
<MemberSignature Language="C#" Value="public int? Gid { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> Gid" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.LinuxUserConfiguration.Gid" />
<MemberSignature Language="VB.NET" Value="Public Property Gid As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.Gid : Nullable<int> with get, set" Usage="Microsoft.Azure.Batch.LinuxUserConfiguration.Gid" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the group ID of the user account.
</summary>
<value>To be added.</value>
<remarks>
The <see cref="P:Microsoft.Azure.Batch.LinuxUserConfiguration.Uid" /> and <see cref="P:Microsoft.Azure.Batch.LinuxUserConfiguration.Gid" /> properties must be specified together or not at all. If not specified,
the underlying operating system picks the gid.
</remarks>
</Docs>
</Member>
<Member MemberName="SshPrivateKey">
<MemberSignature Language="C#" Value="public string SshPrivateKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SshPrivateKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.LinuxUserConfiguration.SshPrivateKey" />
<MemberSignature Language="VB.NET" Value="Public Property SshPrivateKey As String" />
<MemberSignature Language="F#" Value="member this.SshPrivateKey : string with get, set" Usage="Microsoft.Azure.Batch.LinuxUserConfiguration.SshPrivateKey" />
<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 or sets the SSH private key for the user account.
</summary>
<value>To be added.</value>
<remarks>
The private key must not be password protected. The private key is used to automatically configure asymmetric-key
based authentication for SSH between nodes in a Linux pool when the pool's <see cref="P:Microsoft.Azure.Batch.CloudPool.InterComputeNodeCommunicationEnabled" />
property is true (it is ignored if <see cref="P:Microsoft.Azure.Batch.CloudPool.InterComputeNodeCommunicationEnabled" /> is false). It
does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not
configured between nodes (no modification of the user's .ssh directory is done)
</remarks>
</Docs>
</Member>
<Member MemberName="Uid">
<MemberSignature Language="C#" Value="public int? Uid { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> Uid" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Batch.LinuxUserConfiguration.Uid" />
<MemberSignature Language="VB.NET" Value="Public Property Uid As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.Uid : Nullable<int> with get, set" Usage="Microsoft.Azure.Batch.LinuxUserConfiguration.Uid" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Batch</AssemblyName>
<AssemblyVersion>16.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the user ID of the user account.
</summary>
<value>To be added.</value>
<remarks>
The <see cref="P:Microsoft.Azure.Batch.LinuxUserConfiguration.Uid" /> and <see cref="P:Microsoft.Azure.Batch.LinuxUserConfiguration.Gid" /> properties must be specified together or not at all. If not specified,
the underlying operating system picks the uid.
</remarks>
</Docs>
</Member>
</Members>
</Type>