-
Notifications
You must be signed in to change notification settings - Fork 256
/
TpmAttestation.xml
133 lines (133 loc) · 8.08 KB
/
TpmAttestation.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="TpmAttestation" FullName="Microsoft.Azure.Devices.Provisioning.Service.TpmAttestation">
<TypeSignature Language="C#" Value="public sealed class TpmAttestation : Microsoft.Azure.Devices.Provisioning.Service.Attestation" FrameworkAlternate="azure-dotnet" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit TpmAttestation extends Microsoft.Azure.Devices.Provisioning.Service.Attestation" FrameworkAlternate="azure-dotnet" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Provisioning.Service.TpmAttestation" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class TpmAttestation
Inherits Attestation" FrameworkAlternate="azure-dotnet" />
<TypeSignature Language="F#" Value="type TpmAttestation = class
 inherit Attestation" />
<TypeSignature Language="C#" Value="public class TpmAttestation : Microsoft.Azure.Devices.Provisioning.Service.Attestation" FrameworkAlternate="azure-dotnet-preview" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TpmAttestation extends Microsoft.Azure.Devices.Provisioning.Service.Attestation" FrameworkAlternate="azure-dotnet-preview" />
<TypeSignature Language="VB.NET" Value="Public Class TpmAttestation
Inherits Attestation" FrameworkAlternate="azure-dotnet-preview" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
<AssemblyVersion>1.16.3.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
<AssemblyVersion>1.17.1.0</AssemblyVersion>
<AssemblyVersion>1.17.2.0</AssemblyVersion>
<AssemblyVersion>1.18.0.0</AssemblyVersion>
<AssemblyVersion>1.18.1.0</AssemblyVersion>
<AssemblyVersion>1.18.2.0</AssemblyVersion>
<AssemblyVersion>1.19.0.0</AssemblyVersion>
<AssemblyVersion>1.19.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Devices.Provisioning.Service.Attestation</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Representation of a single Device Provisioning Service TPM Attestation.
</summary>
<remarks>
The provisioning service supports Trusted Platform Module, or TPM, as the device attestation mechanism.
User must provide the Endorsement Key, and can, optionally, provide the Storage Root Key.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TpmAttestation (string endorsementKey, string storageRootKey = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string endorsementKey, string storageRootKey) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.Provisioning.Service.TpmAttestation.#ctor(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endorsementKey As String, Optional storageRootKey As String = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.Provisioning.Service.TpmAttestation : string * string -> Microsoft.Azure.Devices.Provisioning.Service.TpmAttestation" Usage="new Microsoft.Azure.Devices.Provisioning.Service.TpmAttestation (endorsementKey, storageRootKey)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
<AssemblyVersion>1.18.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonConstructor]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonConstructor>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="endorsementKey" Type="System.String" />
<Parameter Name="storageRootKey" Type="System.String" />
</Parameters>
<Docs>
<param name="endorsementKey">The string with the TPM endorsement key. It cannot be null or empty.</param>
<param name="storageRootKey">The string with the TPM storage root key. It can be null or empty.</param>
<summary>
Constructor for serialization and unit testing.
</summary>
<remarks>
This function will create a new instance of the TPM attestation
with both endorsement and storage root keys. Only the endorsement
key is mandatory.
</remarks>
<exception cref="T:System.ArgumentNullException">If the provided <paramref name="endorsementKey" /> is null.</exception>
<exception cref="T:System.ArgumentException">If the provided <paramref name="endorsementKey" /> is empty or white space.</exception>
</Docs>
</Member>
<Member MemberName="EndorsementKey">
<MemberSignature Language="C#" Value="public string EndorsementKey { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string EndorsementKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Service.TpmAttestation.EndorsementKey" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EndorsementKey As String" />
<MemberSignature Language="F#" Value="member this.EndorsementKey : string" Usage="Microsoft.Azure.Devices.Provisioning.Service.TpmAttestation.EndorsementKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
<AssemblyVersion>1.18.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="endorsementKey")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="endorsementKey")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the endorsement key used for attestation.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StorageRootKey">
<MemberSignature Language="C#" Value="public string StorageRootKey { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string StorageRootKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Provisioning.Service.TpmAttestation.StorageRootKey" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StorageRootKey As String" />
<MemberSignature Language="F#" Value="member this.StorageRootKey : string" Usage="Microsoft.Azure.Devices.Provisioning.Service.TpmAttestation.StorageRootKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Provisioning.Service</AssemblyName>
<AssemblyVersion>1.18.1.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="storageRootKey")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(DefaultValueHandling=Newtonsoft.Json.DefaultValueHandling.Ignore, PropertyName="storageRootKey")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the storage key used for attestation.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>