JsonWebKey.xml

<Type Name="JsonWebKey" FullName="Azure.ResourceManager.Attestation.Models.JsonWebKey">
  <TypeSignature Language="C#" Value="public class JsonWebKey" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit JsonWebKey extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Azure.ResourceManager.Attestation.Models.JsonWebKey" />
  <TypeSignature Language="VB.NET" Value="Public Class JsonWebKey" />
  <TypeSignature Language="F#" Value="type JsonWebKey = class" />
  <AssemblyInfo>
    <AssemblyName>Azure.ResourceManager.Attestation</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary> The JsonWebKey. </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public JsonWebKey (string kty);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string kty) cil managed" />
      <MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Attestation.Models.JsonWebKey.#ctor(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (kty As String)" />
      <MemberSignature Language="F#" Value="new Azure.ResourceManager.Attestation.Models.JsonWebKey : string -&gt; Azure.ResourceManager.Attestation.Models.JsonWebKey" Usage="new Azure.ResourceManager.Attestation.Models.JsonWebKey kty" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Attestation</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="kty" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="kty">
            The "kty" (key type) parameter identifies the cryptographic algorithm
            family used with the key, such as "RSA" or "EC". "kty" values should
            either be registered in the IANA "JSON Web Key Types" registry
            established by [JWA] or be a value that contains a Collision-
            Resistant Name.  The "kty" value is a case-sensitive string.
            </param>
        <summary> Initializes a new instance of JsonWebKey. </summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="kty" /> is null. </exception>
      </Docs>
    </Member>
    <Member MemberName="Alg">
      <MemberSignature Language="C#" Value="public string Alg { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Alg" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Attestation.Models.JsonWebKey.Alg" />
      <MemberSignature Language="VB.NET" Value="Public Property Alg As String" />
      <MemberSignature Language="F#" Value="member this.Alg : string with get, set" Usage="Azure.ResourceManager.Attestation.Models.JsonWebKey.Alg" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Attestation</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The "alg" (algorithm) parameter identifies the algorithm intended for
            use with the key.  The values used should either be registered in the
            IANA "JSON Web Signature and Encryption Algorithms" registry
            established by [JWA] or be a value that contains a Collision-
            Resistant Name.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Crv">
      <MemberSignature Language="C#" Value="public string Crv { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Crv" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Attestation.Models.JsonWebKey.Crv" />
      <MemberSignature Language="VB.NET" Value="Public Property Crv As String" />
      <MemberSignature Language="F#" Value="member this.Crv : string with get, set" Usage="Azure.ResourceManager.Attestation.Models.JsonWebKey.Crv" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Attestation</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> The "crv" (curve) parameter identifies the curve type. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="D">
      <MemberSignature Language="C#" Value="public string D { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string D" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Attestation.Models.JsonWebKey.D" />
      <MemberSignature Language="VB.NET" Value="Public Property D As String" />
      <MemberSignature Language="F#" Value="member this.D : string with get, set" Usage="Azure.ResourceManager.Attestation.Models.JsonWebKey.D" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Attestation</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> RSA private exponent or ECC private key. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Dp">
      <MemberSignature Language="C#" Value="public string Dp { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Dp" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Attestation.Models.JsonWebKey.Dp" />
      <MemberSignature Language="VB.NET" Value="Public Property Dp As String" />
      <MemberSignature Language="F#" Value="member this.Dp : string with get, set" Usage="Azure.ResourceManager.Attestation.Models.JsonWebKey.Dp" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Attestation</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> RSA Private Key Parameter. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Dq">
      <MemberSignature Language="C#" Value="public string Dq { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Dq" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Attestation.Models.JsonWebKey.Dq" />
      <MemberSignature Language="VB.NET" Value="Public Property Dq As String" />
      <MemberSignature Language="F#" Value="member this.Dq : string with get, set" Usage="Azure.ResourceManager.Attestation.Models.JsonWebKey.Dq" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Attestation</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> RSA Private Key Parameter. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="E">
      <MemberSignature Language="C#" Value="public string E { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string E" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Attestation.Models.JsonWebKey.E" />
      <MemberSignature Language="VB.NET" Value="Public Property E As String" />
      <MemberSignature Language="F#" Value="member this.E : string with get, set" Usage="Azure.ResourceManager.Attestation.Models.JsonWebKey.E" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Attestation</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> RSA public exponent, in Base64. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="K">
      <MemberSignature Language="C#" Value="public string K { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string K" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Attestation.Models.JsonWebKey.K" />
      <MemberSignature Language="VB.NET" Value="Public Property K As String" />
      <MemberSignature Language="F#" Value="member this.K : string with get, set" Usage="Azure.ResourceManager.Attestation.Models.JsonWebKey.K" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Attestation</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Symmetric key. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Kid">
      <MemberSignature Language="C#" Value="public string Kid { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Kid" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Attestation.Models.JsonWebKey.Kid" />
      <MemberSignature Language="VB.NET" Value="Public Property Kid As String" />
      <MemberSignature Language="F#" Value="member this.Kid : string with get, set" Usage="Azure.ResourceManager.Attestation.Models.JsonWebKey.Kid" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Attestation</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The "kid" (key ID) parameter is used to match a specific key.  This
            is used, for instance, to choose among a set of keys within a JWK Set
            during key rollover.  The structure of the "kid" value is
            unspecified.  When "kid" values are used within a JWK Set, different
            keys within the JWK Set SHOULD use distinct "kid" values.  (One
            example in which different keys might use the same "kid" value is if
            they have different "kty" (key type) values but are considered to be
            equivalent alternatives by the application using them.)  The "kid"
            value is a case-sensitive string.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Kty">
      <MemberSignature Language="C#" Value="public string Kty { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Kty" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Attestation.Models.JsonWebKey.Kty" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Kty As String" />
      <MemberSignature Language="F#" Value="member this.Kty : string" Usage="Azure.ResourceManager.Attestation.Models.JsonWebKey.Kty" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Attestation</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The "kty" (key type) parameter identifies the cryptographic algorithm
            family used with the key, such as "RSA" or "EC". "kty" values should
            either be registered in the IANA "JSON Web Key Types" registry
            established by [JWA] or be a value that contains a Collision-
            Resistant Name.  The "kty" value is a case-sensitive string.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="N">
      <MemberSignature Language="C#" Value="public string N { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string N" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Attestation.Models.JsonWebKey.N" />
      <MemberSignature Language="VB.NET" Value="Public Property N As String" />
      <MemberSignature Language="F#" Value="member this.N : string with get, set" Usage="Azure.ResourceManager.Attestation.Models.JsonWebKey.N" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Attestation</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> RSA modulus, in Base64. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="P">
      <MemberSignature Language="C#" Value="public string P { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string P" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Attestation.Models.JsonWebKey.P" />
      <MemberSignature Language="VB.NET" Value="Public Property P As String" />
      <MemberSignature Language="F#" Value="member this.P : string with get, set" Usage="Azure.ResourceManager.Attestation.Models.JsonWebKey.P" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Attestation</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> RSA secret prime. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Q">
      <MemberSignature Language="C#" Value="public string Q { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Q" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Attestation.Models.JsonWebKey.Q" />
      <MemberSignature Language="VB.NET" Value="Public Property Q As String" />
      <MemberSignature Language="F#" Value="member this.Q : string with get, set" Usage="Azure.ResourceManager.Attestation.Models.JsonWebKey.Q" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Attestation</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> RSA secret prime, with p &lt; q. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Qi">
      <MemberSignature Language="C#" Value="public string Qi { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Qi" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Attestation.Models.JsonWebKey.Qi" />
      <MemberSignature Language="VB.NET" Value="Public Property Qi As String" />
      <MemberSignature Language="F#" Value="member this.Qi : string with get, set" Usage="Azure.ResourceManager.Attestation.Models.JsonWebKey.Qi" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Attestation</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> RSA Private Key Parameter. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Use">
      <MemberSignature Language="C#" Value="public string Use { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Use" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Attestation.Models.JsonWebKey.Use" />
      <MemberSignature Language="VB.NET" Value="Public Property Use As String" />
      <MemberSignature Language="F#" Value="member this.Use : string with get, set" Usage="Azure.ResourceManager.Attestation.Models.JsonWebKey.Use" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Attestation</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Use ("public key use") identifies the intended use of
            the public key. The "use" parameter is employed to indicate whether
            a public key is used for encrypting data or verifying the signature
            on data. Values are commonly "sig" (signature) or "enc" (encryption).
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="X">
      <MemberSignature Language="C#" Value="public string X { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string X" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Attestation.Models.JsonWebKey.X" />
      <MemberSignature Language="VB.NET" Value="Public Property X As String" />
      <MemberSignature Language="F#" Value="member this.X : string with get, set" Usage="Azure.ResourceManager.Attestation.Models.JsonWebKey.X" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Attestation</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> X coordinate for the Elliptic Curve point. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="X5C">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;string&gt; X5C { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;string&gt; X5C" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Attestation.Models.JsonWebKey.X5C" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property X5C As IList(Of String)" />
      <MemberSignature Language="F#" Value="member this.X5C : System.Collections.Generic.IList&lt;string&gt;" Usage="Azure.ResourceManager.Attestation.Models.JsonWebKey.X5C" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Attestation</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;System.String&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            The "x5c" (X.509 certificate chain) parameter contains a chain of one
            or more PKIX certificates [RFC5280].  The certificate chain is
            represented as a JSON array of certificate value strings.  Each
            string in the array is a base64-encoded (Section 4 of [RFC4648] --
            not base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.
            The PKIX certificate containing the key value MUST be the first
            certificate.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Y">
      <MemberSignature Language="C#" Value="public string Y { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Y" />
      <MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Attestation.Models.JsonWebKey.Y" />
      <MemberSignature Language="VB.NET" Value="Public Property Y As String" />
      <MemberSignature Language="F#" Value="member this.Y : string with get, set" Usage="Azure.ResourceManager.Attestation.Models.JsonWebKey.Y" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Azure.ResourceManager.Attestation</AssemblyName>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary> Y coordinate for the Elliptic Curve point. </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>