-
Notifications
You must be signed in to change notification settings - Fork 256
/
VaultCertificate.xml
179 lines (179 loc) · 9.88 KB
/
VaultCertificate.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
<Type Name="VaultCertificate" FullName="Microsoft.Azure.Management.ServiceFabric.Models.VaultCertificate">
<TypeSignature Language="C#" Value="public class VaultCertificate" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit VaultCertificate extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.ServiceFabric.Models.VaultCertificate" />
<TypeSignature Language="VB.NET" Value="Public Class VaultCertificate" />
<TypeSignature Language="F#" Value="type VaultCertificate = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.ServiceFabric</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Describes a single certificate reference in a Key Vault, and where the
certificate should reside on the VM.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public VaultCertificate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.ServiceFabric.Models.VaultCertificate.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.ServiceFabric</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the VaultCertificate class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public VaultCertificate (string certificateUrl, string certificateStore);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string certificateUrl, string certificateStore) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.ServiceFabric.Models.VaultCertificate.#ctor(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (certificateUrl As String, certificateStore As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.ServiceFabric.Models.VaultCertificate : string * string -> Microsoft.Azure.Management.ServiceFabric.Models.VaultCertificate" Usage="new Microsoft.Azure.Management.ServiceFabric.Models.VaultCertificate (certificateUrl, certificateStore)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.ServiceFabric</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="certificateUrl" Type="System.String" />
<Parameter Name="certificateStore" Type="System.String" />
</Parameters>
<Docs>
<param name="certificateUrl">This is the URL of a certificate that
has been uploaded to Key Vault as a secret. For adding a secret to
the Key Vault, see [Add a key or secret to the key
vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add).
In this case, your certificate needs to be It is the Base64
encoding of the following JSON Object which is encoded in UTF-8:
<br><br> {<br>
"data":"<Base64-encoded-certificate>",<br>
"dataType":"pfx",<br>
"password":"<pfx-file-password>"<br>}</param>
<param name="certificateStore">For Windows VMs, specifies the
certificate store on the Virtual Machine to which the certificate
should be added. The specified certificate store is implicitly in
the LocalMachine account. <br><br>For Linux VMs, the
certificate file is placed under the /var/lib/waagent directory,
with the file name <UppercaseThumbprint>.crt for the X509
certificate file and <UppercaseThumbprint>.prv for private
key. Both of these files are .pem formatted.</param>
<summary>
Initializes a new instance of the VaultCertificate class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CertificateStore">
<MemberSignature Language="C#" Value="public string CertificateStore { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string CertificateStore" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.ServiceFabric.Models.VaultCertificate.CertificateStore" />
<MemberSignature Language="VB.NET" Value="Public Property CertificateStore As String" />
<MemberSignature Language="F#" Value="member this.CertificateStore : string with get, set" Usage="Microsoft.Azure.Management.ServiceFabric.Models.VaultCertificate.CertificateStore" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.ServiceFabric</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="certificateStore")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="certificateStore")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets for Windows VMs, specifies the certificate store on
the Virtual Machine to which the certificate should be added. The
specified certificate store is implicitly in the LocalMachine
account. &lt;br&gt;&lt;br&gt;For Linux VMs, the
certificate file is placed under the /var/lib/waagent directory,
with the file name &lt;UppercaseThumbprint&gt;.crt for the
X509 certificate file and &lt;UppercaseThumbprint&gt;.prv
for private key. Both of these files are .pem formatted.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CertificateUrl">
<MemberSignature Language="C#" Value="public string CertificateUrl { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string CertificateUrl" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.ServiceFabric.Models.VaultCertificate.CertificateUrl" />
<MemberSignature Language="VB.NET" Value="Public Property CertificateUrl As String" />
<MemberSignature Language="F#" Value="member this.CertificateUrl : string with get, set" Usage="Microsoft.Azure.Management.ServiceFabric.Models.VaultCertificate.CertificateUrl" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.ServiceFabric</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="certificateUrl")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="certificateUrl")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets this is the URL of a certificate that has been
uploaded to Key Vault as a secret. For adding a secret to the Key
Vault, see [Add a key or secret to the key
vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add).
In this case, your certificate needs to be It is the Base64
encoding of the following JSON Object which is encoded in UTF-8:
&lt;br&gt;&lt;br&gt; {&lt;br&gt;
"data":"&lt;Base64-encoded-certificate&gt;",&lt;br&gt;
"dataType":"pfx",&lt;br&gt;
"password":"&lt;pfx-file-password&gt;"&lt;br&gt;}
</summary>
<value>To be added.</value>
<remarks>To be added.</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.ServiceFabric.Models.VaultCertificate.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="vaultCertificate.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.ServiceFabric</AssemblyName>
<AssemblyVersion>1.0.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>
</Members>
</Type>