-
Notifications
You must be signed in to change notification settings - Fork 256
/
ExportJobProperties.xml
109 lines (109 loc) · 6.17 KB
/
ExportJobProperties.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
<Type Name="ExportJobProperties" FullName="Microsoft.Azure.Devices.ExportJobProperties">
<TypeSignature Language="C#" Value="public class ExportJobProperties : Microsoft.Azure.Devices.JobProperties" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ExportJobProperties extends Microsoft.Azure.Devices.JobProperties" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.ExportJobProperties" />
<TypeSignature Language="VB.NET" Value="Public Class ExportJobProperties
Inherits JobProperties" />
<TypeSignature Language="F#" Value="type ExportJobProperties = class
 inherit JobProperties" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Devices.JobProperties</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Contains properties of an export job.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ExportJobProperties (Uri outputBlobContainerUri, bool excludeKeysInExport);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri outputBlobContainerUri, bool excludeKeysInExport) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ExportJobProperties.#ctor(System.Uri,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (outputBlobContainerUri As Uri, excludeKeysInExport As Boolean)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.ExportJobProperties : Uri * bool -> Microsoft.Azure.Devices.ExportJobProperties" Usage="new Microsoft.Azure.Devices.ExportJobProperties (outputBlobContainerUri, excludeKeysInExport)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="outputBlobContainerUri" Type="System.Uri" />
<Parameter Name="excludeKeysInExport" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="outputBlobContainerUri">URI to a blob container, used to output the status of the job and the results.</param>
<param name="excludeKeysInExport">Whether to include authorization keys in export output.</param>
<summary>
Creates an instance of this class for the export job.
</summary>
<remarks>To be added.</remarks>
<altmember cref="M:Microsoft.Azure.Devices.DevicesClient.ExportAsync(Microsoft.Azure.Devices.ExportJobProperties,System.Threading.CancellationToken)" />
</Docs>
</Member>
<Member MemberName="ExcludeKeysInExport">
<MemberSignature Language="C#" Value="public bool ExcludeKeysInExport { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ExcludeKeysInExport" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ExportJobProperties.ExcludeKeysInExport" />
<MemberSignature Language="VB.NET" Value="Public Property ExcludeKeysInExport As Boolean" />
<MemberSignature Language="F#" Value="member this.ExcludeKeysInExport : bool with get, set" Usage="Microsoft.Azure.Devices.ExportJobProperties.ExcludeKeysInExport" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="excludeKeysInExport")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="excludeKeysInExport")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Determines if authorization keys are included in the export.
</summary>
<value>To be added.</value>
<remarks>
Optional parameter. The service defaults to false.
</remarks>
</Docs>
</Member>
<Member MemberName="OutputBlobName">
<MemberSignature Language="C#" Value="public string OutputBlobName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string OutputBlobName" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ExportJobProperties.OutputBlobName" />
<MemberSignature Language="VB.NET" Value="Public Property OutputBlobName As String" />
<MemberSignature Language="F#" Value="member this.OutputBlobName : string with get, set" Usage="Microsoft.Azure.Devices.ExportJobProperties.OutputBlobName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="outputBlobName")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="outputBlobName")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The name of the blob that will be created in the provided output blob container. This blob will contain
the exported device registry information for the IoT hub.
</summary>
<value>To be added.</value>
<remarks>
If not specified, the service defaults to "devices.txt".
</remarks>
</Docs>
</Member>
</Members>
</Type>