-
Notifications
You must be signed in to change notification settings - Fork 255
/
ShareResourcesClient.xml
235 lines (231 loc) · 15.8 KB
/
ShareResourcesClient.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
<Type Name="ShareResourcesClient" FullName="Azure.Analytics.Purview.Sharing.ShareResourcesClient">
<TypeSignature Language="C#" Value="public class ShareResourcesClient" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ShareResourcesClient extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Analytics.Purview.Sharing.ShareResourcesClient" />
<TypeSignature Language="VB.NET" Value="Public Class ShareResourcesClient" />
<TypeSignature Language="F#" Value="type ShareResourcesClient = class" />
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Purview.Sharing</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> The ShareResources service client. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ShareResourcesClient ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.Sharing.ShareResourcesClient.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Purview.Sharing</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary> Initializes a new instance of ShareResourcesClient for mocking. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ShareResourcesClient (Uri endpoint, Azure.Core.TokenCredential credential);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.Sharing.ShareResourcesClient.#ctor(System.Uri,Azure.Core.TokenCredential)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential)" />
<MemberSignature Language="F#" Value="new Azure.Analytics.Purview.Sharing.ShareResourcesClient : Uri * Azure.Core.TokenCredential -> Azure.Analytics.Purview.Sharing.ShareResourcesClient" Usage="new Azure.Analytics.Purview.Sharing.ShareResourcesClient (endpoint, credential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Purview.Sharing</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" />
</Parameters>
<Docs>
<param name="endpoint"> The sharing endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<summary> Initializes a new instance of ShareResourcesClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ShareResourcesClient (Uri endpoint, Azure.Core.TokenCredential credential, Azure.Analytics.Purview.Sharing.PurviewShareClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential, class Azure.Analytics.Purview.Sharing.PurviewShareClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.Sharing.ShareResourcesClient.#ctor(System.Uri,Azure.Core.TokenCredential,Azure.Analytics.Purview.Sharing.PurviewShareClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential, options As PurviewShareClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.Analytics.Purview.Sharing.ShareResourcesClient : Uri * Azure.Core.TokenCredential * Azure.Analytics.Purview.Sharing.PurviewShareClientOptions -> Azure.Analytics.Purview.Sharing.ShareResourcesClient" Usage="new Azure.Analytics.Purview.Sharing.ShareResourcesClient (endpoint, credential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Purview.Sharing</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" />
<Parameter Name="options" Type="Azure.Analytics.Purview.Sharing.PurviewShareClientOptions" />
</Parameters>
<Docs>
<param name="endpoint"> The sharing endpoint of your purview account. Example: https://{accountName}.purview.azure.com/share. </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 ShareResourcesClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="GetAllShareResources">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetAllShareResources (string filter = default, string orderby = default, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetAllShareResources(string filter, string orderby, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.Sharing.ShareResourcesClient.GetAllShareResources(System.String,System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAllShareResources (Optional filter As String = Nothing, Optional orderby As String = Nothing, Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetAllShareResources : string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetAllShareResources : string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="shareResourcesClient.GetAllShareResources (filter, orderby, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Purview.Sharing</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="orderby" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filter"> Filters the results using OData syntax. </param>
<param name="orderby"> Sorts the results using OData syntax. </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] API operation to list ShareResources.
<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 <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetAllShareResources and parse the result.
<code><![CDATA[
var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ShareResourcesClient(endpoint, credential);
foreach (var item in client.GetAllShareResources())
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.ToString());
}
]]></code>
This sample shows how to call GetAllShareResources with all parameters, and how to parse the result.
<code><![CDATA[
var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ShareResourcesClient(endpoint, credential);
foreach (var item in client.GetAllShareResources("<filter>", "<orderby>"))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("receivedSharesCount").ToString());
Console.WriteLine(result.GetProperty("sentSharesCount").ToString());
Console.WriteLine(result.GetProperty("storeKind").ToString());
Console.WriteLine(result.GetProperty("storeReference").GetProperty("referenceName").ToString());
Console.WriteLine(result.GetProperty("storeReference").GetProperty("type").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("type").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetAllShareResourcesAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetAllShareResourcesAsync (string filter = default, string orderby = default, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetAllShareResourcesAsync(string filter, string orderby, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Analytics.Purview.Sharing.ShareResourcesClient.GetAllShareResourcesAsync(System.String,System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAllShareResourcesAsync (Optional filter As String = Nothing, Optional orderby As String = Nothing, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetAllShareResourcesAsync : string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetAllShareResourcesAsync : string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="shareResourcesClient.GetAllShareResourcesAsync (filter, orderby, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Purview.Sharing</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="orderby" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="filter"> Filters the results using OData syntax. </param>
<param name="orderby"> Sorts the results using OData syntax. </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] API operation to list ShareResources.
<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 <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetAllShareResourcesAsync and parse the result.
<code><![CDATA[
var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ShareResourcesClient(endpoint, credential);
await foreach (var item in client.GetAllShareResourcesAsync())
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.ToString());
}
]]></code>
This sample shows how to call GetAllShareResourcesAsync with all parameters, and how to parse the result.
<code><![CDATA[
var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ShareResourcesClient(endpoint, credential);
await foreach (var item in client.GetAllShareResourcesAsync("<filter>", "<orderby>"))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("receivedSharesCount").ToString());
Console.WriteLine(result.GetProperty("sentSharesCount").ToString());
Console.WriteLine(result.GetProperty("storeKind").ToString());
Console.WriteLine(result.GetProperty("storeReference").GetProperty("referenceName").ToString());
Console.WriteLine(result.GetProperty("storeReference").GetProperty("type").ToString());
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("type").ToString());
}
]]></code></example>
</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.Analytics.Purview.Sharing.ShareResourcesClient.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.Analytics.Purview.Sharing.ShareResourcesClient.Pipeline" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Analytics.Purview.Sharing</AssemblyName>
<AssemblyVersion>1.0.0.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>