-
Notifications
You must be signed in to change notification settings - Fork 254
/
CertificateReference.xml
243 lines (243 loc) · 14.5 KB
/
CertificateReference.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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
<Type Name="CertificateReference" FullName="Microsoft.Azure.Management.Batch.Models.CertificateReference">
<TypeSignature Language="C#" Value="public class CertificateReference" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CertificateReference extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.Batch.Models.CertificateReference" />
<TypeSignature Language="VB.NET" Value="Public Class CertificateReference" />
<TypeSignature Language="F#" Value="type CertificateReference = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Batch</AssemblyName>
<AssemblyVersion>13.0.0.0</AssemblyVersion>
<AssemblyVersion>14.0.0.0</AssemblyVersion>
<AssemblyVersion>14.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
A reference to a certificate to be installed on compute nodes in a
pool. This must exist inside the same account as the pool.
</summary>
<remarks>
Warning: This object is deprecated and will be removed after February,
2024. Please use the [Azure KeyVault
Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide)
instead.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CertificateReference ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Batch.Models.CertificateReference.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Batch</AssemblyName>
<AssemblyVersion>14.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the CertificateReference class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CertificateReference (string id, Microsoft.Azure.Management.Batch.Models.CertificateStoreLocation? storeLocation = default, string storeName = default, System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.CertificateVisibility> visibility = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string id, valuetype System.Nullable`1<valuetype Microsoft.Azure.Management.Batch.Models.CertificateStoreLocation> storeLocation, string storeName, class System.Collections.Generic.IList`1<valuetype Microsoft.Azure.Management.Batch.Models.CertificateVisibility> visibility) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Batch.Models.CertificateReference.#ctor(System.String,System.Nullable{Microsoft.Azure.Management.Batch.Models.CertificateStoreLocation},System.String,System.Collections.Generic.IList{Microsoft.Azure.Management.Batch.Models.CertificateVisibility})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (id As String, Optional storeLocation As Nullable(Of CertificateStoreLocation) = Nothing, Optional storeName As String = Nothing, Optional visibility As IList(Of CertificateVisibility) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.Batch.Models.CertificateReference : string * Nullable<Microsoft.Azure.Management.Batch.Models.CertificateStoreLocation> * string * System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.CertificateVisibility> -> Microsoft.Azure.Management.Batch.Models.CertificateReference" Usage="new Microsoft.Azure.Management.Batch.Models.CertificateReference (id, storeLocation, storeName, visibility)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Batch</AssemblyName>
<AssemblyVersion>14.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="id" Type="System.String" />
<Parameter Name="storeLocation" Type="System.Nullable<Microsoft.Azure.Management.Batch.Models.CertificateStoreLocation>" />
<Parameter Name="storeName" Type="System.String" />
<Parameter Name="visibility" Type="System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.CertificateVisibility>" />
</Parameters>
<Docs>
<param name="id">The fully qualified ID of the certificate to
install on the pool. This must be inside the same batch account as
the pool.</param>
<param name="storeLocation">The location of the certificate store
on the compute node into which to install the certificate.</param>
<param name="storeName">The name of the certificate store on the
compute node into which to install the certificate.</param>
<param name="visibility">Which user accounts on the compute node
should have access to the private data of the certificate.</param>
<summary>
Initializes a new instance of the CertificateReference class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public string Id { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Id" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Batch.Models.CertificateReference.Id" />
<MemberSignature Language="VB.NET" Value="Public Property Id As String" />
<MemberSignature Language="F#" Value="member this.Id : string with get, set" Usage="Microsoft.Azure.Management.Batch.Models.CertificateReference.Id" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Batch</AssemblyName>
<AssemblyVersion>14.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="id")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="id")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the fully qualified ID of the certificate to install
on the pool. This must be inside the same batch account as the
pool.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StoreLocation">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Management.Batch.Models.CertificateStoreLocation? StoreLocation { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Management.Batch.Models.CertificateStoreLocation> StoreLocation" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Batch.Models.CertificateReference.StoreLocation" />
<MemberSignature Language="VB.NET" Value="Public Property StoreLocation As Nullable(Of CertificateStoreLocation)" />
<MemberSignature Language="F#" Value="member this.StoreLocation : Nullable<Microsoft.Azure.Management.Batch.Models.CertificateStoreLocation> with get, set" Usage="Microsoft.Azure.Management.Batch.Models.CertificateReference.StoreLocation" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Batch</AssemblyName>
<AssemblyVersion>14.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="storeLocation")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="storeLocation")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Management.Batch.Models.CertificateStoreLocation></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the location of the certificate store on the compute
node into which to install the certificate.
</summary>
<value>To be added.</value>
<remarks>
The default value is currentUser. This property is applicable only
for pools configured with Windows nodes (that is, created with
cloudServiceConfiguration, or with virtualMachineConfiguration
using a Windows image reference). For Linux compute nodes, the
certificates are stored in a directory inside the task working
directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is
supplied to the task to query for this location. For certificates
with visibility of 'remoteUser', a 'certs' directory is created in
the user's home directory (e.g., /home/{user-name}/certs) and
certificates are placed in that directory. Possible values include:
'CurrentUser', 'LocalMachine'
</remarks>
</Docs>
</Member>
<Member MemberName="StoreName">
<MemberSignature Language="C#" Value="public string StoreName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string StoreName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Batch.Models.CertificateReference.StoreName" />
<MemberSignature Language="VB.NET" Value="Public Property StoreName As String" />
<MemberSignature Language="F#" Value="member this.StoreName : string with get, set" Usage="Microsoft.Azure.Management.Batch.Models.CertificateReference.StoreName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Batch</AssemblyName>
<AssemblyVersion>14.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="storeName")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="storeName")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name of the certificate store on the compute node
into which to install the certificate.
</summary>
<value>To be added.</value>
<remarks>
This property is applicable only for pools configured with Windows
nodes (that is, created with cloudServiceConfiguration, or with
virtualMachineConfiguration using a Windows image reference).
Common store names include: My, Root, CA, Trust, Disallowed,
TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any
custom store name can also be used. The default value is My.
</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public virtual void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.Batch.Models.CertificateReference.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Validate ()" />
<MemberSignature Language="F#" Value="abstract member Validate : unit -> unit
override this.Validate : unit -> unit" Usage="certificateReference.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Batch</AssemblyName>
<AssemblyVersion>14.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Validate the object.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown if validation fails
</exception>
</Docs>
</Member>
<Member MemberName="Visibility">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.CertificateVisibility> Visibility { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<valuetype Microsoft.Azure.Management.Batch.Models.CertificateVisibility> Visibility" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.Batch.Models.CertificateReference.Visibility" />
<MemberSignature Language="VB.NET" Value="Public Property Visibility As IList(Of CertificateVisibility)" />
<MemberSignature Language="F#" Value="member this.Visibility : System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.CertificateVisibility> with get, set" Usage="Microsoft.Azure.Management.Batch.Models.CertificateReference.Visibility" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.Batch</AssemblyName>
<AssemblyVersion>14.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="visibility")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="visibility")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Management.Batch.Models.CertificateVisibility></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets which user accounts on the compute node should have
access to the private data of the certificate.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>