-
Notifications
You must be signed in to change notification settings - Fork 255
/
TemplateClient.xml
313 lines (299 loc) · 20.1 KB
/
TemplateClient.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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
<Type Name="TemplateClient" FullName="Azure.Template.TemplateClient">
<TypeSignature Language="C#" Value="public class TemplateClient" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TemplateClient extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Template.TemplateClient" />
<TypeSignature Language="VB.NET" Value="Public Class TemplateClient" />
<TypeSignature Language="F#" Value="type TemplateClient = class" />
<AssemblyInfo>
<AssemblyName>Azure.Template</AssemblyName>
<AssemblyVersion>1.0.3.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> The Template service client. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected TemplateClient ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Template.TemplateClient.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Template</AssemblyName>
<AssemblyVersion>1.0.3.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary> Initializes a new instance of TemplateClient for mocking. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TemplateClient (string vaultBaseUrl, Azure.Core.TokenCredential credential);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string vaultBaseUrl, class Azure.Core.TokenCredential credential) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Template.TemplateClient.#ctor(System.String,Azure.Core.TokenCredential)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (vaultBaseUrl As String, credential As TokenCredential)" />
<MemberSignature Language="F#" Value="new Azure.Template.TemplateClient : string * Azure.Core.TokenCredential -> Azure.Template.TemplateClient" Usage="new Azure.Template.TemplateClient (vaultBaseUrl, credential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Template</AssemblyName>
<AssemblyVersion>1.0.3.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="vaultBaseUrl" Type="System.String" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" />
</Parameters>
<Docs>
<param name="vaultBaseUrl"> The vault name, for example https://myvault.vault.azure.net. </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<summary> Initializes a new instance of TemplateClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="vaultBaseUrl" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TemplateClient (string vaultBaseUrl, Azure.Core.TokenCredential credential, Azure.Template.TemplateClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string vaultBaseUrl, class Azure.Core.TokenCredential credential, class Azure.Template.TemplateClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Template.TemplateClient.#ctor(System.String,Azure.Core.TokenCredential,Azure.Template.TemplateClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (vaultBaseUrl As String, credential As TokenCredential, options As TemplateClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.Template.TemplateClient : string * Azure.Core.TokenCredential * Azure.Template.TemplateClientOptions -> Azure.Template.TemplateClient" Usage="new Azure.Template.TemplateClient (vaultBaseUrl, credential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Template</AssemblyName>
<AssemblyVersion>1.0.3.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="vaultBaseUrl" Type="System.String" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" />
<Parameter Name="options" Type="Azure.Template.TemplateClientOptions" />
</Parameters>
<Docs>
<param name="vaultBaseUrl"> The vault name, for example https://myvault.vault.azure.net. </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<param name="options"> The options for configuring the client. </param>
<summary> Initializes a new instance of TemplateClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="vaultBaseUrl" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="GetSecret">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetSecret (string secretName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetSecret(string secretName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Template.TemplateClient.GetSecret(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSecret (secretName As String, context As RequestContext) As Response" />
<MemberSignature Language="F#" Value="abstract member GetSecret : string * Azure.RequestContext -> Azure.Response
override this.GetSecret : string * Azure.RequestContext -> Azure.Response" Usage="templateClient.GetSecret (secretName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Template</AssemblyName>
<AssemblyVersion>1.0.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="secretName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="secretName"> The name of the secret. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Get a specified secret from a given key vault.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>
The GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission.
Below is the JSON schema for the response payload.
Response Body:
Schema for <c>SecretBundle</c>:
<code>{
value: string, # Optional. The secret value.
id: string, # Optional. The secret id.
contentType: string, # Optional. The content type of the secret.
tags: Dictionary<string, string>, # Optional. Application specific metadata in the form of key-value pairs.
kid: string, # Optional. If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate.
managed: boolean, # Optional. True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true.
}
</code></remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="secretName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="secretName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetSecret and parse the result.
<code><![CDATA[
TokenCredential credential = new DefaultAzureCredential();
TemplateClient client = new TemplateClient("<VaultBaseUrl>", credential);
Response response = client.GetSecret("<secretName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
]]></code>
This sample shows how to call GetSecret with all parameters and parse the result.
<code><![CDATA[
TokenCredential credential = new DefaultAzureCredential();
TemplateClient client = new TemplateClient("<VaultBaseUrl>", credential);
Response response = client.GetSecret("<secretName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("value").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("contentType").ToString());
Console.WriteLine(result.GetProperty("tags").GetProperty("<key>").ToString());
Console.WriteLine(result.GetProperty("kid").ToString());
Console.WriteLine(result.GetProperty("managed").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetSecretAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetSecretAsync (string secretName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetSecretAsync(string secretName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Template.TemplateClient.GetSecretAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSecretAsync (secretName As String, context As RequestContext) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member GetSecretAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetSecretAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="templateClient.GetSecretAsync (secretName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Template</AssemblyName>
<AssemblyVersion>1.0.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="secretName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="secretName"> The name of the secret. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Get a specified secret from a given key vault.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>
The GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission.
Below is the JSON schema for the response payload.
Response Body:
Schema for <c>SecretBundle</c>:
<code>{
value: string, # Optional. The secret value.
id: string, # Optional. The secret id.
contentType: string, # Optional. The content type of the secret.
tags: Dictionary<string, string>, # Optional. Application specific metadata in the form of key-value pairs.
kid: string, # Optional. If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate.
managed: boolean, # Optional. True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true.
}
</code></remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="secretName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="secretName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetSecretAsync and parse the result.
<code><![CDATA[
TokenCredential credential = new DefaultAzureCredential();
TemplateClient client = new TemplateClient("<VaultBaseUrl>", credential);
Response response = await client.GetSecretAsync("<secretName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());
]]></code>
This sample shows how to call GetSecretAsync with all parameters and parse the result.
<code><![CDATA[
TokenCredential credential = new DefaultAzureCredential();
TemplateClient client = new TemplateClient("<VaultBaseUrl>", credential);
Response response = await client.GetSecretAsync("<secretName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("value").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("contentType").ToString());
Console.WriteLine(result.GetProperty("tags").GetProperty("<key>").ToString());
Console.WriteLine(result.GetProperty("kid").ToString());
Console.WriteLine(result.GetProperty("managed").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetSecretValue">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Template.Models.SecretBundle> GetSecretValue (string secretName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Template.Models.SecretBundle> GetSecretValue(string secretName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Template.TemplateClient.GetSecretValue(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSecretValue (secretName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SecretBundle)" />
<MemberSignature Language="F#" Value="abstract member GetSecretValue : string * System.Threading.CancellationToken -> Azure.Response<Azure.Template.Models.SecretBundle>
override this.GetSecretValue : string * System.Threading.CancellationToken -> Azure.Response<Azure.Template.Models.SecretBundle>" Usage="templateClient.GetSecretValue (secretName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Template</AssemblyName>
<AssemblyVersion>1.0.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Template.Models.SecretBundle></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="secretName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="secretName"> The name of the secret. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> The GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetSecretValueAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Template.Models.SecretBundle>> GetSecretValueAsync (string secretName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Template.Models.SecretBundle>> GetSecretValueAsync(string secretName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Template.TemplateClient.GetSecretValueAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetSecretValueAsync (secretName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SecretBundle))" />
<MemberSignature Language="F#" Value="abstract member GetSecretValueAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Template.Models.SecretBundle>>
override this.GetSecretValueAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Template.Models.SecretBundle>>" Usage="templateClient.GetSecretValueAsync (secretName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Template</AssemblyName>
<AssemblyVersion>1.0.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Template.Models.SecretBundle>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="secretName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="secretName"> The name of the secret. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> The GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Pipeline">
<MemberSignature Language="C#" Value="public virtual Azure.Core.Pipeline.HttpPipeline Pipeline { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Core.Pipeline.HttpPipeline Pipeline" />
<MemberSignature Language="DocId" Value="P:Azure.Template.TemplateClient.Pipeline" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Pipeline As HttpPipeline" />
<MemberSignature Language="F#" Value="member this.Pipeline : Azure.Core.Pipeline.HttpPipeline" Usage="Azure.Template.TemplateClient.Pipeline" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Template</AssemblyName>
<AssemblyVersion>1.0.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Core.Pipeline.HttpPipeline</ReturnType>
</ReturnValue>
<Docs>
<summary> The HTTP pipeline for sending and receiving REST requests and responses. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>