-
Notifications
You must be signed in to change notification settings - Fork 262
/
ServiceAuthenticationWithDeviceSharedAccessPolicyToken.xml
133 lines (133 loc) · 8.2 KB
/
ServiceAuthenticationWithDeviceSharedAccessPolicyToken.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
<Type Name="ServiceAuthenticationWithDeviceSharedAccessPolicyToken" FullName="Microsoft.Azure.Devices.ServiceAuthenticationWithDeviceSharedAccessPolicyToken">
<TypeSignature Language="C#" Value="public class ServiceAuthenticationWithDeviceSharedAccessPolicyToken : Microsoft.Azure.Devices.IAuthenticationMethod" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ServiceAuthenticationWithDeviceSharedAccessPolicyToken extends System.Object implements class Microsoft.Azure.Devices.IAuthenticationMethod" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.ServiceAuthenticationWithDeviceSharedAccessPolicyToken" />
<TypeSignature Language="VB.NET" Value="Public Class ServiceAuthenticationWithDeviceSharedAccessPolicyToken
Implements IAuthenticationMethod" />
<TypeSignature Language="F#" Value="type ServiceAuthenticationWithDeviceSharedAccessPolicyToken = class
 interface IAuthenticationMethod" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.31.0.0</AssemblyVersion>
<AssemblyVersion>1.32.0.0</AssemblyVersion>
<AssemblyVersion>1.33.0.0</AssemblyVersion>
<AssemblyVersion>1.34.0.0</AssemblyVersion>
<AssemblyVersion>1.35.0.0</AssemblyVersion>
<AssemblyVersion>1.36.0.0</AssemblyVersion>
<AssemblyVersion>1.37.0.0</AssemblyVersion>
<AssemblyVersion>1.37.1.0</AssemblyVersion>
<AssemblyVersion>1.38.0.0</AssemblyVersion>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Azure.Devices.IAuthenticationMethod</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Authentication method that uses a device's shared access signature to authenticate with service.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ServiceAuthenticationWithDeviceSharedAccessPolicyToken (string deviceId, string sharedAccessSignature);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string deviceId, string sharedAccessSignature) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ServiceAuthenticationWithDeviceSharedAccessPolicyToken.#ctor(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (deviceId As String, sharedAccessSignature As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.ServiceAuthenticationWithDeviceSharedAccessPolicyToken : string * string -> Microsoft.Azure.Devices.ServiceAuthenticationWithDeviceSharedAccessPolicyToken" Usage="new Microsoft.Azure.Devices.ServiceAuthenticationWithDeviceSharedAccessPolicyToken (deviceId, sharedAccessSignature)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="deviceId" Type="System.String" />
<Parameter Name="sharedAccessSignature" Type="System.String" />
</Parameters>
<Docs>
<param name="deviceId">The device Id.</param>
<param name="sharedAccessSignature">The shared access signature.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Devices.ServiceAuthenticationWithDeviceSharedAccessPolicyToken" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeviceId">
<MemberSignature Language="C#" Value="public string DeviceId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string DeviceId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ServiceAuthenticationWithDeviceSharedAccessPolicyToken.DeviceId" />
<MemberSignature Language="VB.NET" Value="Public Property DeviceId As String" />
<MemberSignature Language="F#" Value="member this.DeviceId : string with get, set" Usage="Microsoft.Azure.Devices.ServiceAuthenticationWithDeviceSharedAccessPolicyToken.DeviceId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Name of device
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Populate">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.IotHubConnectionStringBuilder Populate (Microsoft.Azure.Devices.IotHubConnectionStringBuilder iotHubConnectionStringBuilder);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Azure.Devices.IotHubConnectionStringBuilder Populate(class Microsoft.Azure.Devices.IotHubConnectionStringBuilder iotHubConnectionStringBuilder) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.ServiceAuthenticationWithDeviceSharedAccessPolicyToken.Populate(Microsoft.Azure.Devices.IotHubConnectionStringBuilder)" />
<MemberSignature Language="VB.NET" Value="Public Function Populate (iotHubConnectionStringBuilder As IotHubConnectionStringBuilder) As IotHubConnectionStringBuilder" />
<MemberSignature Language="F#" Value="abstract member Populate : Microsoft.Azure.Devices.IotHubConnectionStringBuilder -> Microsoft.Azure.Devices.IotHubConnectionStringBuilder
override this.Populate : Microsoft.Azure.Devices.IotHubConnectionStringBuilder -> Microsoft.Azure.Devices.IotHubConnectionStringBuilder" Usage="serviceAuthenticationWithDeviceSharedAccessPolicyToken.Populate iotHubConnectionStringBuilder" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Azure.Devices.IAuthenticationMethod.Populate(Microsoft.Azure.Devices.IotHubConnectionStringBuilder)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.IotHubConnectionStringBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="iotHubConnectionStringBuilder" Type="Microsoft.Azure.Devices.IotHubConnectionStringBuilder" />
</Parameters>
<Docs>
<param name="iotHubConnectionStringBuilder">The connection build object to populate.</param>
<summary>
Populates the builder with values needed to authenticate with device's shared access signature.
</summary>
<returns>The populated connection string builder object.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Token">
<MemberSignature Language="C#" Value="public string Token { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Token" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.ServiceAuthenticationWithDeviceSharedAccessPolicyToken.Token" />
<MemberSignature Language="VB.NET" Value="Public Property Token As String" />
<MemberSignature Language="F#" Value="member this.Token : string with get, set" Usage="Microsoft.Azure.Devices.ServiceAuthenticationWithDeviceSharedAccessPolicyToken.Token" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>1.38.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Shared access signature generated using device's shared access key
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>